1*83d290c5STom Rini // SPDX-License-Identifier: GPL-2.0+
2961df833SKyungmin Park /*
3961df833SKyungmin Park * Copyright (c) International Business Machines Corp., 2006
4961df833SKyungmin Park *
5961df833SKyungmin Park * Author: Artem Bityutskiy (Битюцкий Артём)
6961df833SKyungmin Park */
7961df833SKyungmin Park
8961df833SKyungmin Park /*
9ff94bc40SHeiko Schocher * The UBI Eraseblock Association (EBA) sub-system.
10961df833SKyungmin Park *
11ff94bc40SHeiko Schocher * This sub-system is responsible for I/O to/from logical eraseblock.
12961df833SKyungmin Park *
13961df833SKyungmin Park * Although in this implementation the EBA table is fully kept and managed in
14961df833SKyungmin Park * RAM, which assumes poor scalability, it might be (partially) maintained on
15961df833SKyungmin Park * flash in future implementations.
16961df833SKyungmin Park *
17ff94bc40SHeiko Schocher * The EBA sub-system implements per-logical eraseblock locking. Before
18ff94bc40SHeiko Schocher * accessing a logical eraseblock it is locked for reading or writing. The
19ff94bc40SHeiko Schocher * per-logical eraseblock locking is implemented by means of the lock tree. The
20ff94bc40SHeiko Schocher * lock tree is an RB-tree which refers all the currently locked logical
21ff94bc40SHeiko Schocher * eraseblocks. The lock tree elements are &struct ubi_ltree_entry objects.
22ff94bc40SHeiko Schocher * They are indexed by (@vol_id, @lnum) pairs.
23961df833SKyungmin Park *
24961df833SKyungmin Park * EBA also maintains the global sequence counter which is incremented each
25961df833SKyungmin Park * time a logical eraseblock is mapped to a physical eraseblock and it is
26961df833SKyungmin Park * stored in the volume identifier header. This means that each VID header has
27961df833SKyungmin Park * a unique sequence number. The sequence number is only increased an we assume
28961df833SKyungmin Park * 64 bits is enough to never overflow.
29961df833SKyungmin Park */
30961df833SKyungmin Park
31ff94bc40SHeiko Schocher #ifndef __UBOOT__
32961df833SKyungmin Park #include <linux/slab.h>
33961df833SKyungmin Park #include <linux/crc32.h>
34ff94bc40SHeiko Schocher #else
35ff94bc40SHeiko Schocher #include <ubi_uboot.h>
36961df833SKyungmin Park #endif
37961df833SKyungmin Park
38ff94bc40SHeiko Schocher #include <linux/err.h>
39961df833SKyungmin Park #include "ubi.h"
40961df833SKyungmin Park
41961df833SKyungmin Park /* Number of physical eraseblocks reserved for atomic LEB change operation */
42961df833SKyungmin Park #define EBA_RESERVED_PEBS 1
43961df833SKyungmin Park
44961df833SKyungmin Park /**
45961df833SKyungmin Park * next_sqnum - get next sequence number.
46961df833SKyungmin Park * @ubi: UBI device description object
47961df833SKyungmin Park *
48961df833SKyungmin Park * This function returns next sequence number to use, which is just the current
49961df833SKyungmin Park * global sequence counter value. It also increases the global sequence
50961df833SKyungmin Park * counter.
51961df833SKyungmin Park */
ubi_next_sqnum(struct ubi_device * ubi)52ff94bc40SHeiko Schocher unsigned long long ubi_next_sqnum(struct ubi_device *ubi)
53961df833SKyungmin Park {
54961df833SKyungmin Park unsigned long long sqnum;
55961df833SKyungmin Park
56961df833SKyungmin Park spin_lock(&ubi->ltree_lock);
57961df833SKyungmin Park sqnum = ubi->global_sqnum++;
58961df833SKyungmin Park spin_unlock(&ubi->ltree_lock);
59961df833SKyungmin Park
60961df833SKyungmin Park return sqnum;
61961df833SKyungmin Park }
62961df833SKyungmin Park
63961df833SKyungmin Park /**
64961df833SKyungmin Park * ubi_get_compat - get compatibility flags of a volume.
65961df833SKyungmin Park * @ubi: UBI device description object
66961df833SKyungmin Park * @vol_id: volume ID
67961df833SKyungmin Park *
68961df833SKyungmin Park * This function returns compatibility flags for an internal volume. User
69961df833SKyungmin Park * volumes have no compatibility flags, so %0 is returned.
70961df833SKyungmin Park */
ubi_get_compat(const struct ubi_device * ubi,int vol_id)71961df833SKyungmin Park static int ubi_get_compat(const struct ubi_device *ubi, int vol_id)
72961df833SKyungmin Park {
73961df833SKyungmin Park if (vol_id == UBI_LAYOUT_VOLUME_ID)
74961df833SKyungmin Park return UBI_LAYOUT_VOLUME_COMPAT;
75961df833SKyungmin Park return 0;
76961df833SKyungmin Park }
77961df833SKyungmin Park
78961df833SKyungmin Park /**
79961df833SKyungmin Park * ltree_lookup - look up the lock tree.
80961df833SKyungmin Park * @ubi: UBI device description object
81961df833SKyungmin Park * @vol_id: volume ID
82961df833SKyungmin Park * @lnum: logical eraseblock number
83961df833SKyungmin Park *
84961df833SKyungmin Park * This function returns a pointer to the corresponding &struct ubi_ltree_entry
85961df833SKyungmin Park * object if the logical eraseblock is locked and %NULL if it is not.
86961df833SKyungmin Park * @ubi->ltree_lock has to be locked.
87961df833SKyungmin Park */
ltree_lookup(struct ubi_device * ubi,int vol_id,int lnum)88961df833SKyungmin Park static struct ubi_ltree_entry *ltree_lookup(struct ubi_device *ubi, int vol_id,
89961df833SKyungmin Park int lnum)
90961df833SKyungmin Park {
91961df833SKyungmin Park struct rb_node *p;
92961df833SKyungmin Park
93961df833SKyungmin Park p = ubi->ltree.rb_node;
94961df833SKyungmin Park while (p) {
95961df833SKyungmin Park struct ubi_ltree_entry *le;
96961df833SKyungmin Park
97961df833SKyungmin Park le = rb_entry(p, struct ubi_ltree_entry, rb);
98961df833SKyungmin Park
99961df833SKyungmin Park if (vol_id < le->vol_id)
100961df833SKyungmin Park p = p->rb_left;
101961df833SKyungmin Park else if (vol_id > le->vol_id)
102961df833SKyungmin Park p = p->rb_right;
103961df833SKyungmin Park else {
104961df833SKyungmin Park if (lnum < le->lnum)
105961df833SKyungmin Park p = p->rb_left;
106961df833SKyungmin Park else if (lnum > le->lnum)
107961df833SKyungmin Park p = p->rb_right;
108961df833SKyungmin Park else
109961df833SKyungmin Park return le;
110961df833SKyungmin Park }
111961df833SKyungmin Park }
112961df833SKyungmin Park
113961df833SKyungmin Park return NULL;
114961df833SKyungmin Park }
115961df833SKyungmin Park
116961df833SKyungmin Park /**
117961df833SKyungmin Park * ltree_add_entry - add new entry to the lock tree.
118961df833SKyungmin Park * @ubi: UBI device description object
119961df833SKyungmin Park * @vol_id: volume ID
120961df833SKyungmin Park * @lnum: logical eraseblock number
121961df833SKyungmin Park *
122961df833SKyungmin Park * This function adds new entry for logical eraseblock (@vol_id, @lnum) to the
123961df833SKyungmin Park * lock tree. If such entry is already there, its usage counter is increased.
124961df833SKyungmin Park * Returns pointer to the lock tree entry or %-ENOMEM if memory allocation
125961df833SKyungmin Park * failed.
126961df833SKyungmin Park */
ltree_add_entry(struct ubi_device * ubi,int vol_id,int lnum)127961df833SKyungmin Park static struct ubi_ltree_entry *ltree_add_entry(struct ubi_device *ubi,
128961df833SKyungmin Park int vol_id, int lnum)
129961df833SKyungmin Park {
130961df833SKyungmin Park struct ubi_ltree_entry *le, *le1, *le_free;
131961df833SKyungmin Park
132961df833SKyungmin Park le = kmalloc(sizeof(struct ubi_ltree_entry), GFP_NOFS);
133961df833SKyungmin Park if (!le)
134961df833SKyungmin Park return ERR_PTR(-ENOMEM);
135961df833SKyungmin Park
136961df833SKyungmin Park le->users = 0;
137961df833SKyungmin Park init_rwsem(&le->mutex);
138961df833SKyungmin Park le->vol_id = vol_id;
139961df833SKyungmin Park le->lnum = lnum;
140961df833SKyungmin Park
141961df833SKyungmin Park spin_lock(&ubi->ltree_lock);
142961df833SKyungmin Park le1 = ltree_lookup(ubi, vol_id, lnum);
143961df833SKyungmin Park
144961df833SKyungmin Park if (le1) {
145961df833SKyungmin Park /*
146961df833SKyungmin Park * This logical eraseblock is already locked. The newly
147961df833SKyungmin Park * allocated lock entry is not needed.
148961df833SKyungmin Park */
149961df833SKyungmin Park le_free = le;
150961df833SKyungmin Park le = le1;
151961df833SKyungmin Park } else {
152961df833SKyungmin Park struct rb_node **p, *parent = NULL;
153961df833SKyungmin Park
154961df833SKyungmin Park /*
155961df833SKyungmin Park * No lock entry, add the newly allocated one to the
156961df833SKyungmin Park * @ubi->ltree RB-tree.
157961df833SKyungmin Park */
158961df833SKyungmin Park le_free = NULL;
159961df833SKyungmin Park
160961df833SKyungmin Park p = &ubi->ltree.rb_node;
161961df833SKyungmin Park while (*p) {
162961df833SKyungmin Park parent = *p;
163961df833SKyungmin Park le1 = rb_entry(parent, struct ubi_ltree_entry, rb);
164961df833SKyungmin Park
165961df833SKyungmin Park if (vol_id < le1->vol_id)
166961df833SKyungmin Park p = &(*p)->rb_left;
167961df833SKyungmin Park else if (vol_id > le1->vol_id)
168961df833SKyungmin Park p = &(*p)->rb_right;
169961df833SKyungmin Park else {
170961df833SKyungmin Park ubi_assert(lnum != le1->lnum);
171961df833SKyungmin Park if (lnum < le1->lnum)
172961df833SKyungmin Park p = &(*p)->rb_left;
173961df833SKyungmin Park else
174961df833SKyungmin Park p = &(*p)->rb_right;
175961df833SKyungmin Park }
176961df833SKyungmin Park }
177961df833SKyungmin Park
178961df833SKyungmin Park rb_link_node(&le->rb, parent, p);
179961df833SKyungmin Park rb_insert_color(&le->rb, &ubi->ltree);
180961df833SKyungmin Park }
181961df833SKyungmin Park le->users += 1;
182961df833SKyungmin Park spin_unlock(&ubi->ltree_lock);
183961df833SKyungmin Park
184961df833SKyungmin Park kfree(le_free);
185961df833SKyungmin Park return le;
186961df833SKyungmin Park }
187961df833SKyungmin Park
188961df833SKyungmin Park /**
189961df833SKyungmin Park * leb_read_lock - lock logical eraseblock for reading.
190961df833SKyungmin Park * @ubi: UBI device description object
191961df833SKyungmin Park * @vol_id: volume ID
192961df833SKyungmin Park * @lnum: logical eraseblock number
193961df833SKyungmin Park *
194961df833SKyungmin Park * This function locks a logical eraseblock for reading. Returns zero in case
195961df833SKyungmin Park * of success and a negative error code in case of failure.
196961df833SKyungmin Park */
leb_read_lock(struct ubi_device * ubi,int vol_id,int lnum)197961df833SKyungmin Park static int leb_read_lock(struct ubi_device *ubi, int vol_id, int lnum)
198961df833SKyungmin Park {
199961df833SKyungmin Park struct ubi_ltree_entry *le;
200961df833SKyungmin Park
201961df833SKyungmin Park le = ltree_add_entry(ubi, vol_id, lnum);
202961df833SKyungmin Park if (IS_ERR(le))
203961df833SKyungmin Park return PTR_ERR(le);
204961df833SKyungmin Park down_read(&le->mutex);
205961df833SKyungmin Park return 0;
206961df833SKyungmin Park }
207961df833SKyungmin Park
208961df833SKyungmin Park /**
209961df833SKyungmin Park * leb_read_unlock - unlock logical eraseblock.
210961df833SKyungmin Park * @ubi: UBI device description object
211961df833SKyungmin Park * @vol_id: volume ID
212961df833SKyungmin Park * @lnum: logical eraseblock number
213961df833SKyungmin Park */
leb_read_unlock(struct ubi_device * ubi,int vol_id,int lnum)214961df833SKyungmin Park static void leb_read_unlock(struct ubi_device *ubi, int vol_id, int lnum)
215961df833SKyungmin Park {
216961df833SKyungmin Park struct ubi_ltree_entry *le;
217961df833SKyungmin Park
218961df833SKyungmin Park spin_lock(&ubi->ltree_lock);
219961df833SKyungmin Park le = ltree_lookup(ubi, vol_id, lnum);
220961df833SKyungmin Park le->users -= 1;
221961df833SKyungmin Park ubi_assert(le->users >= 0);
222ff94bc40SHeiko Schocher up_read(&le->mutex);
223961df833SKyungmin Park if (le->users == 0) {
224961df833SKyungmin Park rb_erase(&le->rb, &ubi->ltree);
225ff94bc40SHeiko Schocher kfree(le);
226961df833SKyungmin Park }
227961df833SKyungmin Park spin_unlock(&ubi->ltree_lock);
228961df833SKyungmin Park }
229961df833SKyungmin Park
230961df833SKyungmin Park /**
231961df833SKyungmin Park * leb_write_lock - lock logical eraseblock for writing.
232961df833SKyungmin Park * @ubi: UBI device description object
233961df833SKyungmin Park * @vol_id: volume ID
234961df833SKyungmin Park * @lnum: logical eraseblock number
235961df833SKyungmin Park *
236961df833SKyungmin Park * This function locks a logical eraseblock for writing. Returns zero in case
237961df833SKyungmin Park * of success and a negative error code in case of failure.
238961df833SKyungmin Park */
leb_write_lock(struct ubi_device * ubi,int vol_id,int lnum)239961df833SKyungmin Park static int leb_write_lock(struct ubi_device *ubi, int vol_id, int lnum)
240961df833SKyungmin Park {
241961df833SKyungmin Park struct ubi_ltree_entry *le;
242961df833SKyungmin Park
243961df833SKyungmin Park le = ltree_add_entry(ubi, vol_id, lnum);
244961df833SKyungmin Park if (IS_ERR(le))
245961df833SKyungmin Park return PTR_ERR(le);
246961df833SKyungmin Park down_write(&le->mutex);
247961df833SKyungmin Park return 0;
248961df833SKyungmin Park }
249961df833SKyungmin Park
250961df833SKyungmin Park /**
251961df833SKyungmin Park * leb_write_lock - lock logical eraseblock for writing.
252961df833SKyungmin Park * @ubi: UBI device description object
253961df833SKyungmin Park * @vol_id: volume ID
254961df833SKyungmin Park * @lnum: logical eraseblock number
255961df833SKyungmin Park *
256961df833SKyungmin Park * This function locks a logical eraseblock for writing if there is no
257961df833SKyungmin Park * contention and does nothing if there is contention. Returns %0 in case of
258961df833SKyungmin Park * success, %1 in case of contention, and and a negative error code in case of
259961df833SKyungmin Park * failure.
260961df833SKyungmin Park */
leb_write_trylock(struct ubi_device * ubi,int vol_id,int lnum)261961df833SKyungmin Park static int leb_write_trylock(struct ubi_device *ubi, int vol_id, int lnum)
262961df833SKyungmin Park {
263961df833SKyungmin Park struct ubi_ltree_entry *le;
264961df833SKyungmin Park
265961df833SKyungmin Park le = ltree_add_entry(ubi, vol_id, lnum);
266961df833SKyungmin Park if (IS_ERR(le))
267961df833SKyungmin Park return PTR_ERR(le);
268961df833SKyungmin Park if (down_write_trylock(&le->mutex))
269961df833SKyungmin Park return 0;
270961df833SKyungmin Park
271961df833SKyungmin Park /* Contention, cancel */
272961df833SKyungmin Park spin_lock(&ubi->ltree_lock);
273961df833SKyungmin Park le->users -= 1;
274961df833SKyungmin Park ubi_assert(le->users >= 0);
275961df833SKyungmin Park if (le->users == 0) {
276961df833SKyungmin Park rb_erase(&le->rb, &ubi->ltree);
277961df833SKyungmin Park kfree(le);
278ff94bc40SHeiko Schocher }
279ff94bc40SHeiko Schocher spin_unlock(&ubi->ltree_lock);
280961df833SKyungmin Park
281961df833SKyungmin Park return 1;
282961df833SKyungmin Park }
283961df833SKyungmin Park
284961df833SKyungmin Park /**
285961df833SKyungmin Park * leb_write_unlock - unlock logical eraseblock.
286961df833SKyungmin Park * @ubi: UBI device description object
287961df833SKyungmin Park * @vol_id: volume ID
288961df833SKyungmin Park * @lnum: logical eraseblock number
289961df833SKyungmin Park */
leb_write_unlock(struct ubi_device * ubi,int vol_id,int lnum)290961df833SKyungmin Park static void leb_write_unlock(struct ubi_device *ubi, int vol_id, int lnum)
291961df833SKyungmin Park {
292961df833SKyungmin Park struct ubi_ltree_entry *le;
293961df833SKyungmin Park
294961df833SKyungmin Park spin_lock(&ubi->ltree_lock);
295961df833SKyungmin Park le = ltree_lookup(ubi, vol_id, lnum);
296961df833SKyungmin Park le->users -= 1;
297961df833SKyungmin Park ubi_assert(le->users >= 0);
298ff94bc40SHeiko Schocher up_write(&le->mutex);
299961df833SKyungmin Park if (le->users == 0) {
300961df833SKyungmin Park rb_erase(&le->rb, &ubi->ltree);
301961df833SKyungmin Park kfree(le);
302961df833SKyungmin Park }
303ff94bc40SHeiko Schocher spin_unlock(&ubi->ltree_lock);
304ff94bc40SHeiko Schocher }
305961df833SKyungmin Park
306961df833SKyungmin Park /**
307961df833SKyungmin Park * ubi_eba_unmap_leb - un-map logical eraseblock.
308961df833SKyungmin Park * @ubi: UBI device description object
309961df833SKyungmin Park * @vol: volume description object
310961df833SKyungmin Park * @lnum: logical eraseblock number
311961df833SKyungmin Park *
312961df833SKyungmin Park * This function un-maps logical eraseblock @lnum and schedules corresponding
313961df833SKyungmin Park * physical eraseblock for erasure. Returns zero in case of success and a
314961df833SKyungmin Park * negative error code in case of failure.
315961df833SKyungmin Park */
ubi_eba_unmap_leb(struct ubi_device * ubi,struct ubi_volume * vol,int lnum)316961df833SKyungmin Park int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
317961df833SKyungmin Park int lnum)
318961df833SKyungmin Park {
319961df833SKyungmin Park int err, pnum, vol_id = vol->vol_id;
320961df833SKyungmin Park
321961df833SKyungmin Park if (ubi->ro_mode)
322961df833SKyungmin Park return -EROFS;
323961df833SKyungmin Park
324961df833SKyungmin Park err = leb_write_lock(ubi, vol_id, lnum);
325961df833SKyungmin Park if (err)
326961df833SKyungmin Park return err;
327961df833SKyungmin Park
328961df833SKyungmin Park pnum = vol->eba_tbl[lnum];
329961df833SKyungmin Park if (pnum < 0)
330961df833SKyungmin Park /* This logical eraseblock is already unmapped */
331961df833SKyungmin Park goto out_unlock;
332961df833SKyungmin Park
333961df833SKyungmin Park dbg_eba("erase LEB %d:%d, PEB %d", vol_id, lnum, pnum);
334961df833SKyungmin Park
3350195a7bbSHeiko Schocher down_read(&ubi->fm_eba_sem);
336961df833SKyungmin Park vol->eba_tbl[lnum] = UBI_LEB_UNMAPPED;
3370195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
338ff94bc40SHeiko Schocher err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 0);
339961df833SKyungmin Park
340961df833SKyungmin Park out_unlock:
341961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
342961df833SKyungmin Park return err;
343961df833SKyungmin Park }
344961df833SKyungmin Park
345961df833SKyungmin Park /**
346961df833SKyungmin Park * ubi_eba_read_leb - read data.
347961df833SKyungmin Park * @ubi: UBI device description object
348961df833SKyungmin Park * @vol: volume description object
349961df833SKyungmin Park * @lnum: logical eraseblock number
350961df833SKyungmin Park * @buf: buffer to store the read data
351961df833SKyungmin Park * @offset: offset from where to read
352961df833SKyungmin Park * @len: how many bytes to read
353961df833SKyungmin Park * @check: data CRC check flag
354961df833SKyungmin Park *
355961df833SKyungmin Park * If the logical eraseblock @lnum is unmapped, @buf is filled with 0xFF
356961df833SKyungmin Park * bytes. The @check flag only makes sense for static volumes and forces
357961df833SKyungmin Park * eraseblock data CRC checking.
358961df833SKyungmin Park *
359961df833SKyungmin Park * In case of success this function returns zero. In case of a static volume,
360961df833SKyungmin Park * if data CRC mismatches - %-EBADMSG is returned. %-EBADMSG may also be
361961df833SKyungmin Park * returned for any volume type if an ECC error was detected by the MTD device
362961df833SKyungmin Park * driver. Other negative error cored may be returned in case of other errors.
363961df833SKyungmin Park */
ubi_eba_read_leb(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,void * buf,int offset,int len,int check)364961df833SKyungmin Park int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
365961df833SKyungmin Park void *buf, int offset, int len, int check)
366961df833SKyungmin Park {
367961df833SKyungmin Park int err, pnum, scrub = 0, vol_id = vol->vol_id;
368961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr;
369961df833SKyungmin Park uint32_t uninitialized_var(crc);
370961df833SKyungmin Park
371961df833SKyungmin Park err = leb_read_lock(ubi, vol_id, lnum);
372961df833SKyungmin Park if (err)
373961df833SKyungmin Park return err;
374961df833SKyungmin Park
375961df833SKyungmin Park pnum = vol->eba_tbl[lnum];
376961df833SKyungmin Park if (pnum < 0) {
377961df833SKyungmin Park /*
378961df833SKyungmin Park * The logical eraseblock is not mapped, fill the whole buffer
379961df833SKyungmin Park * with 0xFF bytes. The exception is static volumes for which
380961df833SKyungmin Park * it is an error to read unmapped logical eraseblocks.
381961df833SKyungmin Park */
382961df833SKyungmin Park dbg_eba("read %d bytes from offset %d of LEB %d:%d (unmapped)",
383961df833SKyungmin Park len, offset, vol_id, lnum);
384961df833SKyungmin Park leb_read_unlock(ubi, vol_id, lnum);
385961df833SKyungmin Park ubi_assert(vol->vol_type != UBI_STATIC_VOLUME);
386961df833SKyungmin Park memset(buf, 0xFF, len);
387961df833SKyungmin Park return 0;
388961df833SKyungmin Park }
389961df833SKyungmin Park
390961df833SKyungmin Park dbg_eba("read %d bytes from offset %d of LEB %d:%d, PEB %d",
391961df833SKyungmin Park len, offset, vol_id, lnum, pnum);
392961df833SKyungmin Park
393961df833SKyungmin Park if (vol->vol_type == UBI_DYNAMIC_VOLUME)
394961df833SKyungmin Park check = 0;
395961df833SKyungmin Park
396961df833SKyungmin Park retry:
397961df833SKyungmin Park if (check) {
398961df833SKyungmin Park vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
399961df833SKyungmin Park if (!vid_hdr) {
400961df833SKyungmin Park err = -ENOMEM;
401961df833SKyungmin Park goto out_unlock;
402961df833SKyungmin Park }
403961df833SKyungmin Park
404961df833SKyungmin Park err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
405961df833SKyungmin Park if (err && err != UBI_IO_BITFLIPS) {
406961df833SKyungmin Park if (err > 0) {
407961df833SKyungmin Park /*
408961df833SKyungmin Park * The header is either absent or corrupted.
409961df833SKyungmin Park * The former case means there is a bug -
410961df833SKyungmin Park * switch to read-only mode just in case.
411961df833SKyungmin Park * The latter case means a real corruption - we
412961df833SKyungmin Park * may try to recover data. FIXME: but this is
413961df833SKyungmin Park * not implemented.
414961df833SKyungmin Park */
415ff94bc40SHeiko Schocher if (err == UBI_IO_BAD_HDR_EBADMSG ||
416ff94bc40SHeiko Schocher err == UBI_IO_BAD_HDR) {
4170195a7bbSHeiko Schocher ubi_warn(ubi, "corrupted VID header at PEB %d, LEB %d:%d",
418ff94bc40SHeiko Schocher pnum, vol_id, lnum);
419961df833SKyungmin Park err = -EBADMSG;
4200195a7bbSHeiko Schocher } else {
4210195a7bbSHeiko Schocher err = -EINVAL;
422961df833SKyungmin Park ubi_ro_mode(ubi);
423961df833SKyungmin Park }
4240195a7bbSHeiko Schocher }
425961df833SKyungmin Park goto out_free;
426961df833SKyungmin Park } else if (err == UBI_IO_BITFLIPS)
427961df833SKyungmin Park scrub = 1;
428961df833SKyungmin Park
429961df833SKyungmin Park ubi_assert(lnum < be32_to_cpu(vid_hdr->used_ebs));
430961df833SKyungmin Park ubi_assert(len == be32_to_cpu(vid_hdr->data_size));
431961df833SKyungmin Park
432961df833SKyungmin Park crc = be32_to_cpu(vid_hdr->data_crc);
433961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
434961df833SKyungmin Park }
435961df833SKyungmin Park
436961df833SKyungmin Park err = ubi_io_read_data(ubi, buf, pnum, offset, len);
437961df833SKyungmin Park if (err) {
4380195a7bbSHeiko Schocher if (err == UBI_IO_BITFLIPS)
439961df833SKyungmin Park scrub = 1;
4400195a7bbSHeiko Schocher else if (mtd_is_eccerr(err)) {
441961df833SKyungmin Park if (vol->vol_type == UBI_DYNAMIC_VOLUME)
442961df833SKyungmin Park goto out_unlock;
443961df833SKyungmin Park scrub = 1;
444961df833SKyungmin Park if (!check) {
4450195a7bbSHeiko Schocher ubi_msg(ubi, "force data checking");
446961df833SKyungmin Park check = 1;
447961df833SKyungmin Park goto retry;
448961df833SKyungmin Park }
449961df833SKyungmin Park } else
450961df833SKyungmin Park goto out_unlock;
451961df833SKyungmin Park }
452961df833SKyungmin Park
453961df833SKyungmin Park if (check) {
454961df833SKyungmin Park uint32_t crc1 = crc32(UBI_CRC32_INIT, buf, len);
455961df833SKyungmin Park if (crc1 != crc) {
4560195a7bbSHeiko Schocher ubi_warn(ubi, "CRC error: calculated %#08x, must be %#08x",
457961df833SKyungmin Park crc1, crc);
458961df833SKyungmin Park err = -EBADMSG;
459961df833SKyungmin Park goto out_unlock;
460961df833SKyungmin Park }
461961df833SKyungmin Park }
462961df833SKyungmin Park
463961df833SKyungmin Park if (scrub)
464961df833SKyungmin Park err = ubi_wl_scrub_peb(ubi, pnum);
465961df833SKyungmin Park
466961df833SKyungmin Park leb_read_unlock(ubi, vol_id, lnum);
467961df833SKyungmin Park return err;
468961df833SKyungmin Park
469961df833SKyungmin Park out_free:
470961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
471961df833SKyungmin Park out_unlock:
472961df833SKyungmin Park leb_read_unlock(ubi, vol_id, lnum);
473961df833SKyungmin Park return err;
474961df833SKyungmin Park }
475961df833SKyungmin Park
4760195a7bbSHeiko Schocher #ifndef __UBOOT__
4770195a7bbSHeiko Schocher /**
4780195a7bbSHeiko Schocher * ubi_eba_read_leb_sg - read data into a scatter gather list.
4790195a7bbSHeiko Schocher * @ubi: UBI device description object
4800195a7bbSHeiko Schocher * @vol: volume description object
4810195a7bbSHeiko Schocher * @lnum: logical eraseblock number
4820195a7bbSHeiko Schocher * @sgl: UBI scatter gather list to store the read data
4830195a7bbSHeiko Schocher * @offset: offset from where to read
4840195a7bbSHeiko Schocher * @len: how many bytes to read
4850195a7bbSHeiko Schocher * @check: data CRC check flag
4860195a7bbSHeiko Schocher *
4870195a7bbSHeiko Schocher * This function works exactly like ubi_eba_read_leb(). But instead of
4880195a7bbSHeiko Schocher * storing the read data into a buffer it writes to an UBI scatter gather
4890195a7bbSHeiko Schocher * list.
4900195a7bbSHeiko Schocher */
ubi_eba_read_leb_sg(struct ubi_device * ubi,struct ubi_volume * vol,struct ubi_sgl * sgl,int lnum,int offset,int len,int check)4910195a7bbSHeiko Schocher int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
4920195a7bbSHeiko Schocher struct ubi_sgl *sgl, int lnum, int offset, int len,
4930195a7bbSHeiko Schocher int check)
4940195a7bbSHeiko Schocher {
4950195a7bbSHeiko Schocher int to_read;
4960195a7bbSHeiko Schocher int ret;
4970195a7bbSHeiko Schocher struct scatterlist *sg;
4980195a7bbSHeiko Schocher
4990195a7bbSHeiko Schocher for (;;) {
5000195a7bbSHeiko Schocher ubi_assert(sgl->list_pos < UBI_MAX_SG_COUNT);
5010195a7bbSHeiko Schocher sg = &sgl->sg[sgl->list_pos];
5020195a7bbSHeiko Schocher if (len < sg->length - sgl->page_pos)
5030195a7bbSHeiko Schocher to_read = len;
5040195a7bbSHeiko Schocher else
5050195a7bbSHeiko Schocher to_read = sg->length - sgl->page_pos;
5060195a7bbSHeiko Schocher
5070195a7bbSHeiko Schocher ret = ubi_eba_read_leb(ubi, vol, lnum,
5080195a7bbSHeiko Schocher sg_virt(sg) + sgl->page_pos, offset,
5090195a7bbSHeiko Schocher to_read, check);
5100195a7bbSHeiko Schocher if (ret < 0)
5110195a7bbSHeiko Schocher return ret;
5120195a7bbSHeiko Schocher
5130195a7bbSHeiko Schocher offset += to_read;
5140195a7bbSHeiko Schocher len -= to_read;
5150195a7bbSHeiko Schocher if (!len) {
5160195a7bbSHeiko Schocher sgl->page_pos += to_read;
5170195a7bbSHeiko Schocher if (sgl->page_pos == sg->length) {
5180195a7bbSHeiko Schocher sgl->list_pos++;
5190195a7bbSHeiko Schocher sgl->page_pos = 0;
5200195a7bbSHeiko Schocher }
5210195a7bbSHeiko Schocher
5220195a7bbSHeiko Schocher break;
5230195a7bbSHeiko Schocher }
5240195a7bbSHeiko Schocher
5250195a7bbSHeiko Schocher sgl->list_pos++;
5260195a7bbSHeiko Schocher sgl->page_pos = 0;
5270195a7bbSHeiko Schocher }
5280195a7bbSHeiko Schocher
5290195a7bbSHeiko Schocher return ret;
5300195a7bbSHeiko Schocher }
5310195a7bbSHeiko Schocher #endif
5320195a7bbSHeiko Schocher
533961df833SKyungmin Park /**
534961df833SKyungmin Park * recover_peb - recover from write failure.
535961df833SKyungmin Park * @ubi: UBI device description object
536961df833SKyungmin Park * @pnum: the physical eraseblock to recover
537961df833SKyungmin Park * @vol_id: volume ID
538961df833SKyungmin Park * @lnum: logical eraseblock number
539961df833SKyungmin Park * @buf: data which was not written because of the write failure
540961df833SKyungmin Park * @offset: offset of the failed write
541961df833SKyungmin Park * @len: how many bytes should have been written
542961df833SKyungmin Park *
543961df833SKyungmin Park * This function is called in case of a write failure and moves all good data
544961df833SKyungmin Park * from the potentially bad physical eraseblock to a good physical eraseblock.
545961df833SKyungmin Park * This function also writes the data which was not written due to the failure.
546961df833SKyungmin Park * Returns new physical eraseblock number in case of success, and a negative
547961df833SKyungmin Park * error code in case of failure.
548961df833SKyungmin Park */
recover_peb(struct ubi_device * ubi,int pnum,int vol_id,int lnum,const void * buf,int offset,int len)549961df833SKyungmin Park static int recover_peb(struct ubi_device *ubi, int pnum, int vol_id, int lnum,
550961df833SKyungmin Park const void *buf, int offset, int len)
551961df833SKyungmin Park {
552961df833SKyungmin Park int err, idx = vol_id2idx(ubi, vol_id), new_pnum, data_size, tries = 0;
553961df833SKyungmin Park struct ubi_volume *vol = ubi->volumes[idx];
554961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr;
555961df833SKyungmin Park
556961df833SKyungmin Park vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
557ff94bc40SHeiko Schocher if (!vid_hdr)
558961df833SKyungmin Park return -ENOMEM;
559961df833SKyungmin Park
560961df833SKyungmin Park retry:
561ff94bc40SHeiko Schocher new_pnum = ubi_wl_get_peb(ubi);
562961df833SKyungmin Park if (new_pnum < 0) {
563961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
5640195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
565961df833SKyungmin Park return new_pnum;
566961df833SKyungmin Park }
567961df833SKyungmin Park
5680195a7bbSHeiko Schocher ubi_msg(ubi, "recover PEB %d, move data to PEB %d",
5690195a7bbSHeiko Schocher pnum, new_pnum);
570961df833SKyungmin Park
571961df833SKyungmin Park err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
572961df833SKyungmin Park if (err && err != UBI_IO_BITFLIPS) {
573961df833SKyungmin Park if (err > 0)
574961df833SKyungmin Park err = -EIO;
5750195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
576961df833SKyungmin Park goto out_put;
577961df833SKyungmin Park }
578961df833SKyungmin Park
579ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
580961df833SKyungmin Park err = ubi_io_write_vid_hdr(ubi, new_pnum, vid_hdr);
5810195a7bbSHeiko Schocher if (err) {
5820195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
583961df833SKyungmin Park goto write_error;
5840195a7bbSHeiko Schocher }
585961df833SKyungmin Park
586961df833SKyungmin Park data_size = offset + len;
587ff94bc40SHeiko Schocher mutex_lock(&ubi->buf_mutex);
588ff94bc40SHeiko Schocher memset(ubi->peb_buf + offset, 0xFF, len);
589961df833SKyungmin Park
590961df833SKyungmin Park /* Read everything before the area where the write failure happened */
591961df833SKyungmin Park if (offset > 0) {
592ff94bc40SHeiko Schocher err = ubi_io_read_data(ubi, ubi->peb_buf, pnum, 0, offset);
5930195a7bbSHeiko Schocher if (err && err != UBI_IO_BITFLIPS) {
5940195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
595ff94bc40SHeiko Schocher goto out_unlock;
596961df833SKyungmin Park }
5970195a7bbSHeiko Schocher }
598961df833SKyungmin Park
599ff94bc40SHeiko Schocher memcpy(ubi->peb_buf + offset, buf, len);
600961df833SKyungmin Park
601ff94bc40SHeiko Schocher err = ubi_io_write_data(ubi, ubi->peb_buf, new_pnum, 0, data_size);
602ff94bc40SHeiko Schocher if (err) {
603ff94bc40SHeiko Schocher mutex_unlock(&ubi->buf_mutex);
6040195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
605961df833SKyungmin Park goto write_error;
606ff94bc40SHeiko Schocher }
607961df833SKyungmin Park
608961df833SKyungmin Park mutex_unlock(&ubi->buf_mutex);
609961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
610961df833SKyungmin Park
611961df833SKyungmin Park vol->eba_tbl[lnum] = new_pnum;
6120195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
613ff94bc40SHeiko Schocher ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
614961df833SKyungmin Park
6150195a7bbSHeiko Schocher ubi_msg(ubi, "data was successfully recovered");
616961df833SKyungmin Park return 0;
617961df833SKyungmin Park
618ff94bc40SHeiko Schocher out_unlock:
619961df833SKyungmin Park mutex_unlock(&ubi->buf_mutex);
620ff94bc40SHeiko Schocher out_put:
621ff94bc40SHeiko Schocher ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
622961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
623961df833SKyungmin Park return err;
624961df833SKyungmin Park
625961df833SKyungmin Park write_error:
626961df833SKyungmin Park /*
627961df833SKyungmin Park * Bad luck? This physical eraseblock is bad too? Crud. Let's try to
628961df833SKyungmin Park * get another one.
629961df833SKyungmin Park */
6300195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write to PEB %d", new_pnum);
631ff94bc40SHeiko Schocher ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
632961df833SKyungmin Park if (++tries > UBI_IO_RETRIES) {
633961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
634961df833SKyungmin Park return err;
635961df833SKyungmin Park }
6360195a7bbSHeiko Schocher ubi_msg(ubi, "try again");
637961df833SKyungmin Park goto retry;
638961df833SKyungmin Park }
639961df833SKyungmin Park
640961df833SKyungmin Park /**
641961df833SKyungmin Park * ubi_eba_write_leb - write data to dynamic volume.
642961df833SKyungmin Park * @ubi: UBI device description object
643961df833SKyungmin Park * @vol: volume description object
644961df833SKyungmin Park * @lnum: logical eraseblock number
645961df833SKyungmin Park * @buf: the data to write
646961df833SKyungmin Park * @offset: offset within the logical eraseblock where to write
647961df833SKyungmin Park * @len: how many bytes to write
648961df833SKyungmin Park *
649961df833SKyungmin Park * This function writes data to logical eraseblock @lnum of a dynamic volume
650961df833SKyungmin Park * @vol. Returns zero in case of success and a negative error code in case
651961df833SKyungmin Park * of failure. In case of error, it is possible that something was still
652961df833SKyungmin Park * written to the flash media, but may be some garbage.
653961df833SKyungmin Park */
ubi_eba_write_leb(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,const void * buf,int offset,int len)654961df833SKyungmin Park int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
655ff94bc40SHeiko Schocher const void *buf, int offset, int len)
656961df833SKyungmin Park {
657961df833SKyungmin Park int err, pnum, tries = 0, vol_id = vol->vol_id;
658961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr;
659961df833SKyungmin Park
660961df833SKyungmin Park if (ubi->ro_mode)
661961df833SKyungmin Park return -EROFS;
662961df833SKyungmin Park
663961df833SKyungmin Park err = leb_write_lock(ubi, vol_id, lnum);
664961df833SKyungmin Park if (err)
665961df833SKyungmin Park return err;
666961df833SKyungmin Park
667961df833SKyungmin Park pnum = vol->eba_tbl[lnum];
668961df833SKyungmin Park if (pnum >= 0) {
669961df833SKyungmin Park dbg_eba("write %d bytes at offset %d of LEB %d:%d, PEB %d",
670961df833SKyungmin Park len, offset, vol_id, lnum, pnum);
671961df833SKyungmin Park
672961df833SKyungmin Park err = ubi_io_write_data(ubi, buf, pnum, offset, len);
673961df833SKyungmin Park if (err) {
6740195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write data to PEB %d", pnum);
675961df833SKyungmin Park if (err == -EIO && ubi->bad_allowed)
676961df833SKyungmin Park err = recover_peb(ubi, pnum, vol_id, lnum, buf,
677961df833SKyungmin Park offset, len);
678961df833SKyungmin Park if (err)
679961df833SKyungmin Park ubi_ro_mode(ubi);
680961df833SKyungmin Park }
681961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
682961df833SKyungmin Park return err;
683961df833SKyungmin Park }
684961df833SKyungmin Park
685961df833SKyungmin Park /*
686961df833SKyungmin Park * The logical eraseblock is not mapped. We have to get a free physical
687961df833SKyungmin Park * eraseblock and write the volume identifier header there first.
688961df833SKyungmin Park */
689961df833SKyungmin Park vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
690961df833SKyungmin Park if (!vid_hdr) {
691961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
692961df833SKyungmin Park return -ENOMEM;
693961df833SKyungmin Park }
694961df833SKyungmin Park
695961df833SKyungmin Park vid_hdr->vol_type = UBI_VID_DYNAMIC;
696ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
697961df833SKyungmin Park vid_hdr->vol_id = cpu_to_be32(vol_id);
698961df833SKyungmin Park vid_hdr->lnum = cpu_to_be32(lnum);
699961df833SKyungmin Park vid_hdr->compat = ubi_get_compat(ubi, vol_id);
700961df833SKyungmin Park vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
701961df833SKyungmin Park
702961df833SKyungmin Park retry:
703ff94bc40SHeiko Schocher pnum = ubi_wl_get_peb(ubi);
704961df833SKyungmin Park if (pnum < 0) {
705961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
706961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
7070195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
708961df833SKyungmin Park return pnum;
709961df833SKyungmin Park }
710961df833SKyungmin Park
711961df833SKyungmin Park dbg_eba("write VID hdr and %d bytes at offset %d of LEB %d:%d, PEB %d",
712961df833SKyungmin Park len, offset, vol_id, lnum, pnum);
713961df833SKyungmin Park
714961df833SKyungmin Park err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
715961df833SKyungmin Park if (err) {
7160195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
717961df833SKyungmin Park vol_id, lnum, pnum);
7180195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
719961df833SKyungmin Park goto write_error;
720961df833SKyungmin Park }
721961df833SKyungmin Park
722961df833SKyungmin Park if (len) {
723961df833SKyungmin Park err = ubi_io_write_data(ubi, buf, pnum, offset, len);
724961df833SKyungmin Park if (err) {
7250195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write %d bytes at offset %d of LEB %d:%d, PEB %d",
726ff94bc40SHeiko Schocher len, offset, vol_id, lnum, pnum);
7270195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
728961df833SKyungmin Park goto write_error;
729961df833SKyungmin Park }
730961df833SKyungmin Park }
731961df833SKyungmin Park
732961df833SKyungmin Park vol->eba_tbl[lnum] = pnum;
7330195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
734961df833SKyungmin Park
735961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
736961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
737961df833SKyungmin Park return 0;
738961df833SKyungmin Park
739961df833SKyungmin Park write_error:
740961df833SKyungmin Park if (err != -EIO || !ubi->bad_allowed) {
741961df833SKyungmin Park ubi_ro_mode(ubi);
742961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
743961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
744961df833SKyungmin Park return err;
745961df833SKyungmin Park }
746961df833SKyungmin Park
747961df833SKyungmin Park /*
748961df833SKyungmin Park * Fortunately, this is the first write operation to this physical
749961df833SKyungmin Park * eraseblock, so just put it and request a new one. We assume that if
750961df833SKyungmin Park * this physical eraseblock went bad, the erase code will handle that.
751961df833SKyungmin Park */
752ff94bc40SHeiko Schocher err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
753961df833SKyungmin Park if (err || ++tries > UBI_IO_RETRIES) {
754961df833SKyungmin Park ubi_ro_mode(ubi);
755961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
756961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
757961df833SKyungmin Park return err;
758961df833SKyungmin Park }
759961df833SKyungmin Park
760ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
7610195a7bbSHeiko Schocher ubi_msg(ubi, "try another PEB");
762961df833SKyungmin Park goto retry;
763961df833SKyungmin Park }
764961df833SKyungmin Park
765961df833SKyungmin Park /**
766961df833SKyungmin Park * ubi_eba_write_leb_st - write data to static volume.
767961df833SKyungmin Park * @ubi: UBI device description object
768961df833SKyungmin Park * @vol: volume description object
769961df833SKyungmin Park * @lnum: logical eraseblock number
770961df833SKyungmin Park * @buf: data to write
771961df833SKyungmin Park * @len: how many bytes to write
772961df833SKyungmin Park * @used_ebs: how many logical eraseblocks will this volume contain
773961df833SKyungmin Park *
774961df833SKyungmin Park * This function writes data to logical eraseblock @lnum of static volume
775961df833SKyungmin Park * @vol. The @used_ebs argument should contain total number of logical
776961df833SKyungmin Park * eraseblock in this static volume.
777961df833SKyungmin Park *
778961df833SKyungmin Park * When writing to the last logical eraseblock, the @len argument doesn't have
779961df833SKyungmin Park * to be aligned to the minimal I/O unit size. Instead, it has to be equivalent
780961df833SKyungmin Park * to the real data size, although the @buf buffer has to contain the
781961df833SKyungmin Park * alignment. In all other cases, @len has to be aligned.
782961df833SKyungmin Park *
783ff94bc40SHeiko Schocher * It is prohibited to write more than once to logical eraseblocks of static
784961df833SKyungmin Park * volumes. This function returns zero in case of success and a negative error
785961df833SKyungmin Park * code in case of failure.
786961df833SKyungmin Park */
ubi_eba_write_leb_st(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,const void * buf,int len,int used_ebs)787961df833SKyungmin Park int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
788ff94bc40SHeiko Schocher int lnum, const void *buf, int len, int used_ebs)
789961df833SKyungmin Park {
790961df833SKyungmin Park int err, pnum, tries = 0, data_size = len, vol_id = vol->vol_id;
791961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr;
792961df833SKyungmin Park uint32_t crc;
793961df833SKyungmin Park
794961df833SKyungmin Park if (ubi->ro_mode)
795961df833SKyungmin Park return -EROFS;
796961df833SKyungmin Park
797961df833SKyungmin Park if (lnum == used_ebs - 1)
798961df833SKyungmin Park /* If this is the last LEB @len may be unaligned */
799961df833SKyungmin Park len = ALIGN(data_size, ubi->min_io_size);
800961df833SKyungmin Park else
801961df833SKyungmin Park ubi_assert(!(len & (ubi->min_io_size - 1)));
802961df833SKyungmin Park
803961df833SKyungmin Park vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
804961df833SKyungmin Park if (!vid_hdr)
805961df833SKyungmin Park return -ENOMEM;
806961df833SKyungmin Park
807961df833SKyungmin Park err = leb_write_lock(ubi, vol_id, lnum);
808961df833SKyungmin Park if (err) {
809961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
810961df833SKyungmin Park return err;
811961df833SKyungmin Park }
812961df833SKyungmin Park
813ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
814961df833SKyungmin Park vid_hdr->vol_id = cpu_to_be32(vol_id);
815961df833SKyungmin Park vid_hdr->lnum = cpu_to_be32(lnum);
816961df833SKyungmin Park vid_hdr->compat = ubi_get_compat(ubi, vol_id);
817961df833SKyungmin Park vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
818961df833SKyungmin Park
819961df833SKyungmin Park crc = crc32(UBI_CRC32_INIT, buf, data_size);
820961df833SKyungmin Park vid_hdr->vol_type = UBI_VID_STATIC;
821961df833SKyungmin Park vid_hdr->data_size = cpu_to_be32(data_size);
822961df833SKyungmin Park vid_hdr->used_ebs = cpu_to_be32(used_ebs);
823961df833SKyungmin Park vid_hdr->data_crc = cpu_to_be32(crc);
824961df833SKyungmin Park
825961df833SKyungmin Park retry:
826ff94bc40SHeiko Schocher pnum = ubi_wl_get_peb(ubi);
827961df833SKyungmin Park if (pnum < 0) {
828961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
829961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
8300195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
831961df833SKyungmin Park return pnum;
832961df833SKyungmin Park }
833961df833SKyungmin Park
834961df833SKyungmin Park dbg_eba("write VID hdr and %d bytes at LEB %d:%d, PEB %d, used_ebs %d",
835961df833SKyungmin Park len, vol_id, lnum, pnum, used_ebs);
836961df833SKyungmin Park
837961df833SKyungmin Park err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
838961df833SKyungmin Park if (err) {
8390195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
840961df833SKyungmin Park vol_id, lnum, pnum);
8410195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
842961df833SKyungmin Park goto write_error;
843961df833SKyungmin Park }
844961df833SKyungmin Park
845961df833SKyungmin Park err = ubi_io_write_data(ubi, buf, pnum, 0, len);
846961df833SKyungmin Park if (err) {
8470195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
848961df833SKyungmin Park len, pnum);
8490195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
850961df833SKyungmin Park goto write_error;
851961df833SKyungmin Park }
852961df833SKyungmin Park
853961df833SKyungmin Park ubi_assert(vol->eba_tbl[lnum] < 0);
854961df833SKyungmin Park vol->eba_tbl[lnum] = pnum;
8550195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
856961df833SKyungmin Park
857961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
858961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
859961df833SKyungmin Park return 0;
860961df833SKyungmin Park
861961df833SKyungmin Park write_error:
862961df833SKyungmin Park if (err != -EIO || !ubi->bad_allowed) {
863961df833SKyungmin Park /*
864961df833SKyungmin Park * This flash device does not admit of bad eraseblocks or
865961df833SKyungmin Park * something nasty and unexpected happened. Switch to read-only
866961df833SKyungmin Park * mode just in case.
867961df833SKyungmin Park */
868961df833SKyungmin Park ubi_ro_mode(ubi);
869961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
870961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
871961df833SKyungmin Park return err;
872961df833SKyungmin Park }
873961df833SKyungmin Park
874ff94bc40SHeiko Schocher err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
875961df833SKyungmin Park if (err || ++tries > UBI_IO_RETRIES) {
876961df833SKyungmin Park ubi_ro_mode(ubi);
877961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
878961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
879961df833SKyungmin Park return err;
880961df833SKyungmin Park }
881961df833SKyungmin Park
882ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
8830195a7bbSHeiko Schocher ubi_msg(ubi, "try another PEB");
884961df833SKyungmin Park goto retry;
885961df833SKyungmin Park }
886961df833SKyungmin Park
887961df833SKyungmin Park /*
888961df833SKyungmin Park * ubi_eba_atomic_leb_change - change logical eraseblock atomically.
889961df833SKyungmin Park * @ubi: UBI device description object
890961df833SKyungmin Park * @vol: volume description object
891961df833SKyungmin Park * @lnum: logical eraseblock number
892961df833SKyungmin Park * @buf: data to write
893961df833SKyungmin Park * @len: how many bytes to write
894961df833SKyungmin Park *
895961df833SKyungmin Park * This function changes the contents of a logical eraseblock atomically. @buf
896961df833SKyungmin Park * has to contain new logical eraseblock data, and @len - the length of the
897961df833SKyungmin Park * data, which has to be aligned. This function guarantees that in case of an
898961df833SKyungmin Park * unclean reboot the old contents is preserved. Returns zero in case of
899961df833SKyungmin Park * success and a negative error code in case of failure.
900961df833SKyungmin Park *
901961df833SKyungmin Park * UBI reserves one LEB for the "atomic LEB change" operation, so only one
902961df833SKyungmin Park * LEB change may be done at a time. This is ensured by @ubi->alc_mutex.
903961df833SKyungmin Park */
ubi_eba_atomic_leb_change(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,const void * buf,int len)904961df833SKyungmin Park int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
905ff94bc40SHeiko Schocher int lnum, const void *buf, int len)
906961df833SKyungmin Park {
9070195a7bbSHeiko Schocher int err, pnum, old_pnum, tries = 0, vol_id = vol->vol_id;
908961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr;
909961df833SKyungmin Park uint32_t crc;
910961df833SKyungmin Park
911961df833SKyungmin Park if (ubi->ro_mode)
912961df833SKyungmin Park return -EROFS;
913961df833SKyungmin Park
914961df833SKyungmin Park if (len == 0) {
915961df833SKyungmin Park /*
916961df833SKyungmin Park * Special case when data length is zero. In this case the LEB
917961df833SKyungmin Park * has to be unmapped and mapped somewhere else.
918961df833SKyungmin Park */
919961df833SKyungmin Park err = ubi_eba_unmap_leb(ubi, vol, lnum);
920961df833SKyungmin Park if (err)
921961df833SKyungmin Park return err;
922ff94bc40SHeiko Schocher return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0);
923961df833SKyungmin Park }
924961df833SKyungmin Park
925961df833SKyungmin Park vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
926961df833SKyungmin Park if (!vid_hdr)
927961df833SKyungmin Park return -ENOMEM;
928961df833SKyungmin Park
929961df833SKyungmin Park mutex_lock(&ubi->alc_mutex);
930961df833SKyungmin Park err = leb_write_lock(ubi, vol_id, lnum);
931961df833SKyungmin Park if (err)
932961df833SKyungmin Park goto out_mutex;
933961df833SKyungmin Park
934ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
935961df833SKyungmin Park vid_hdr->vol_id = cpu_to_be32(vol_id);
936961df833SKyungmin Park vid_hdr->lnum = cpu_to_be32(lnum);
937961df833SKyungmin Park vid_hdr->compat = ubi_get_compat(ubi, vol_id);
938961df833SKyungmin Park vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
939961df833SKyungmin Park
940961df833SKyungmin Park crc = crc32(UBI_CRC32_INIT, buf, len);
941961df833SKyungmin Park vid_hdr->vol_type = UBI_VID_DYNAMIC;
942961df833SKyungmin Park vid_hdr->data_size = cpu_to_be32(len);
943961df833SKyungmin Park vid_hdr->copy_flag = 1;
944961df833SKyungmin Park vid_hdr->data_crc = cpu_to_be32(crc);
945961df833SKyungmin Park
946961df833SKyungmin Park retry:
947ff94bc40SHeiko Schocher pnum = ubi_wl_get_peb(ubi);
948961df833SKyungmin Park if (pnum < 0) {
949961df833SKyungmin Park err = pnum;
9500195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
951961df833SKyungmin Park goto out_leb_unlock;
952961df833SKyungmin Park }
953961df833SKyungmin Park
954961df833SKyungmin Park dbg_eba("change LEB %d:%d, PEB %d, write VID hdr to PEB %d",
955961df833SKyungmin Park vol_id, lnum, vol->eba_tbl[lnum], pnum);
956961df833SKyungmin Park
957961df833SKyungmin Park err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
958961df833SKyungmin Park if (err) {
9590195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
960961df833SKyungmin Park vol_id, lnum, pnum);
9610195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
962961df833SKyungmin Park goto write_error;
963961df833SKyungmin Park }
964961df833SKyungmin Park
965961df833SKyungmin Park err = ubi_io_write_data(ubi, buf, pnum, 0, len);
966961df833SKyungmin Park if (err) {
9670195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
968961df833SKyungmin Park len, pnum);
9690195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
970961df833SKyungmin Park goto write_error;
971961df833SKyungmin Park }
972961df833SKyungmin Park
9730195a7bbSHeiko Schocher old_pnum = vol->eba_tbl[lnum];
9740195a7bbSHeiko Schocher vol->eba_tbl[lnum] = pnum;
9750195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
9760195a7bbSHeiko Schocher
9770195a7bbSHeiko Schocher if (old_pnum >= 0) {
9780195a7bbSHeiko Schocher err = ubi_wl_put_peb(ubi, vol_id, lnum, old_pnum, 0);
979961df833SKyungmin Park if (err)
980961df833SKyungmin Park goto out_leb_unlock;
981961df833SKyungmin Park }
982961df833SKyungmin Park
983961df833SKyungmin Park out_leb_unlock:
984961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
985961df833SKyungmin Park out_mutex:
986961df833SKyungmin Park mutex_unlock(&ubi->alc_mutex);
987961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
988961df833SKyungmin Park return err;
989961df833SKyungmin Park
990961df833SKyungmin Park write_error:
991961df833SKyungmin Park if (err != -EIO || !ubi->bad_allowed) {
992961df833SKyungmin Park /*
993961df833SKyungmin Park * This flash device does not admit of bad eraseblocks or
994961df833SKyungmin Park * something nasty and unexpected happened. Switch to read-only
995961df833SKyungmin Park * mode just in case.
996961df833SKyungmin Park */
997961df833SKyungmin Park ubi_ro_mode(ubi);
998961df833SKyungmin Park goto out_leb_unlock;
999961df833SKyungmin Park }
1000961df833SKyungmin Park
1001ff94bc40SHeiko Schocher err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
1002961df833SKyungmin Park if (err || ++tries > UBI_IO_RETRIES) {
1003961df833SKyungmin Park ubi_ro_mode(ubi);
1004961df833SKyungmin Park goto out_leb_unlock;
1005961df833SKyungmin Park }
1006961df833SKyungmin Park
1007ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
10080195a7bbSHeiko Schocher ubi_msg(ubi, "try another PEB");
1009961df833SKyungmin Park goto retry;
1010961df833SKyungmin Park }
1011961df833SKyungmin Park
1012961df833SKyungmin Park /**
1013ff94bc40SHeiko Schocher * is_error_sane - check whether a read error is sane.
1014ff94bc40SHeiko Schocher * @err: code of the error happened during reading
1015ff94bc40SHeiko Schocher *
1016ff94bc40SHeiko Schocher * This is a helper function for 'ubi_eba_copy_leb()' which is called when we
1017ff94bc40SHeiko Schocher * cannot read data from the target PEB (an error @err happened). If the error
1018ff94bc40SHeiko Schocher * code is sane, then we treat this error as non-fatal. Otherwise the error is
1019ff94bc40SHeiko Schocher * fatal and UBI will be switched to R/O mode later.
1020ff94bc40SHeiko Schocher *
1021ff94bc40SHeiko Schocher * The idea is that we try not to switch to R/O mode if the read error is
1022ff94bc40SHeiko Schocher * something which suggests there was a real read problem. E.g., %-EIO. Or a
1023ff94bc40SHeiko Schocher * memory allocation failed (-%ENOMEM). Otherwise, it is safer to switch to R/O
1024ff94bc40SHeiko Schocher * mode, simply because we do not know what happened at the MTD level, and we
1025ff94bc40SHeiko Schocher * cannot handle this. E.g., the underlying driver may have become crazy, and
1026ff94bc40SHeiko Schocher * it is safer to switch to R/O mode to preserve the data.
1027ff94bc40SHeiko Schocher *
1028ff94bc40SHeiko Schocher * And bear in mind, this is about reading from the target PEB, i.e. the PEB
1029ff94bc40SHeiko Schocher * which we have just written.
1030ff94bc40SHeiko Schocher */
is_error_sane(int err)1031ff94bc40SHeiko Schocher static int is_error_sane(int err)
1032ff94bc40SHeiko Schocher {
1033ff94bc40SHeiko Schocher if (err == -EIO || err == -ENOMEM || err == UBI_IO_BAD_HDR ||
1034ff94bc40SHeiko Schocher err == UBI_IO_BAD_HDR_EBADMSG || err == -ETIMEDOUT)
1035ff94bc40SHeiko Schocher return 0;
1036ff94bc40SHeiko Schocher return 1;
1037ff94bc40SHeiko Schocher }
1038ff94bc40SHeiko Schocher
1039ff94bc40SHeiko Schocher /**
1040961df833SKyungmin Park * ubi_eba_copy_leb - copy logical eraseblock.
1041961df833SKyungmin Park * @ubi: UBI device description object
1042961df833SKyungmin Park * @from: physical eraseblock number from where to copy
1043961df833SKyungmin Park * @to: physical eraseblock number where to copy
1044961df833SKyungmin Park * @vid_hdr: VID header of the @from physical eraseblock
1045961df833SKyungmin Park *
1046961df833SKyungmin Park * This function copies logical eraseblock from physical eraseblock @from to
1047961df833SKyungmin Park * physical eraseblock @to. The @vid_hdr buffer may be changed by this
1048961df833SKyungmin Park * function. Returns:
1049961df833SKyungmin Park * o %0 in case of success;
1050ff94bc40SHeiko Schocher * o %MOVE_CANCEL_RACE, %MOVE_TARGET_WR_ERR, %MOVE_TARGET_BITFLIPS, etc;
1051ff94bc40SHeiko Schocher * o a negative error code in case of failure.
1052961df833SKyungmin Park */
ubi_eba_copy_leb(struct ubi_device * ubi,int from,int to,struct ubi_vid_hdr * vid_hdr)1053961df833SKyungmin Park int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
1054961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr)
1055961df833SKyungmin Park {
1056961df833SKyungmin Park int err, vol_id, lnum, data_size, aldata_size, idx;
1057961df833SKyungmin Park struct ubi_volume *vol;
1058961df833SKyungmin Park uint32_t crc;
1059961df833SKyungmin Park
1060961df833SKyungmin Park vol_id = be32_to_cpu(vid_hdr->vol_id);
1061961df833SKyungmin Park lnum = be32_to_cpu(vid_hdr->lnum);
1062961df833SKyungmin Park
1063ff94bc40SHeiko Schocher dbg_wl("copy LEB %d:%d, PEB %d to PEB %d", vol_id, lnum, from, to);
1064961df833SKyungmin Park
1065961df833SKyungmin Park if (vid_hdr->vol_type == UBI_VID_STATIC) {
1066961df833SKyungmin Park data_size = be32_to_cpu(vid_hdr->data_size);
1067961df833SKyungmin Park aldata_size = ALIGN(data_size, ubi->min_io_size);
1068961df833SKyungmin Park } else
1069961df833SKyungmin Park data_size = aldata_size =
1070961df833SKyungmin Park ubi->leb_size - be32_to_cpu(vid_hdr->data_pad);
1071961df833SKyungmin Park
1072961df833SKyungmin Park idx = vol_id2idx(ubi, vol_id);
1073961df833SKyungmin Park spin_lock(&ubi->volumes_lock);
1074961df833SKyungmin Park /*
1075961df833SKyungmin Park * Note, we may race with volume deletion, which means that the volume
1076961df833SKyungmin Park * this logical eraseblock belongs to might be being deleted. Since the
1077ff94bc40SHeiko Schocher * volume deletion un-maps all the volume's logical eraseblocks, it will
1078961df833SKyungmin Park * be locked in 'ubi_wl_put_peb()' and wait for the WL worker to finish.
1079961df833SKyungmin Park */
1080961df833SKyungmin Park vol = ubi->volumes[idx];
1081ff94bc40SHeiko Schocher spin_unlock(&ubi->volumes_lock);
1082961df833SKyungmin Park if (!vol) {
1083961df833SKyungmin Park /* No need to do further work, cancel */
1084ff94bc40SHeiko Schocher dbg_wl("volume %d is being removed, cancel", vol_id);
1085ff94bc40SHeiko Schocher return MOVE_CANCEL_RACE;
1086961df833SKyungmin Park }
1087961df833SKyungmin Park
1088961df833SKyungmin Park /*
1089961df833SKyungmin Park * We do not want anybody to write to this logical eraseblock while we
1090961df833SKyungmin Park * are moving it, so lock it.
1091961df833SKyungmin Park *
1092961df833SKyungmin Park * Note, we are using non-waiting locking here, because we cannot sleep
1093961df833SKyungmin Park * on the LEB, since it may cause deadlocks. Indeed, imagine a task is
1094961df833SKyungmin Park * unmapping the LEB which is mapped to the PEB we are going to move
1095961df833SKyungmin Park * (@from). This task locks the LEB and goes sleep in the
1096961df833SKyungmin Park * 'ubi_wl_put_peb()' function on the @ubi->move_mutex. In turn, we are
1097961df833SKyungmin Park * holding @ubi->move_mutex and go sleep on the LEB lock. So, if the
1098ff94bc40SHeiko Schocher * LEB is already locked, we just do not move it and return
1099ff94bc40SHeiko Schocher * %MOVE_RETRY. Note, we do not return %MOVE_CANCEL_RACE here because
1100ff94bc40SHeiko Schocher * we do not know the reasons of the contention - it may be just a
1101ff94bc40SHeiko Schocher * normal I/O on this LEB, so we want to re-try.
1102961df833SKyungmin Park */
1103961df833SKyungmin Park err = leb_write_trylock(ubi, vol_id, lnum);
1104961df833SKyungmin Park if (err) {
1105ff94bc40SHeiko Schocher dbg_wl("contention on LEB %d:%d, cancel", vol_id, lnum);
1106ff94bc40SHeiko Schocher return MOVE_RETRY;
1107961df833SKyungmin Park }
1108961df833SKyungmin Park
1109961df833SKyungmin Park /*
1110961df833SKyungmin Park * The LEB might have been put meanwhile, and the task which put it is
1111961df833SKyungmin Park * probably waiting on @ubi->move_mutex. No need to continue the work,
1112961df833SKyungmin Park * cancel it.
1113961df833SKyungmin Park */
1114961df833SKyungmin Park if (vol->eba_tbl[lnum] != from) {
1115ff94bc40SHeiko Schocher dbg_wl("LEB %d:%d is no longer mapped to PEB %d, mapped to PEB %d, cancel",
1116ff94bc40SHeiko Schocher vol_id, lnum, from, vol->eba_tbl[lnum]);
1117ff94bc40SHeiko Schocher err = MOVE_CANCEL_RACE;
1118961df833SKyungmin Park goto out_unlock_leb;
1119961df833SKyungmin Park }
1120961df833SKyungmin Park
1121961df833SKyungmin Park /*
1122ff94bc40SHeiko Schocher * OK, now the LEB is locked and we can safely start moving it. Since
1123ff94bc40SHeiko Schocher * this function utilizes the @ubi->peb_buf buffer which is shared
1124ff94bc40SHeiko Schocher * with some other functions - we lock the buffer by taking the
1125961df833SKyungmin Park * @ubi->buf_mutex.
1126961df833SKyungmin Park */
1127961df833SKyungmin Park mutex_lock(&ubi->buf_mutex);
1128ff94bc40SHeiko Schocher dbg_wl("read %d bytes of data", aldata_size);
1129ff94bc40SHeiko Schocher err = ubi_io_read_data(ubi, ubi->peb_buf, from, 0, aldata_size);
1130961df833SKyungmin Park if (err && err != UBI_IO_BITFLIPS) {
11310195a7bbSHeiko Schocher ubi_warn(ubi, "error %d while reading data from PEB %d",
1132961df833SKyungmin Park err, from);
1133ff94bc40SHeiko Schocher err = MOVE_SOURCE_RD_ERR;
1134961df833SKyungmin Park goto out_unlock_buf;
1135961df833SKyungmin Park }
1136961df833SKyungmin Park
1137961df833SKyungmin Park /*
1138ff94bc40SHeiko Schocher * Now we have got to calculate how much data we have to copy. In
1139961df833SKyungmin Park * case of a static volume it is fairly easy - the VID header contains
1140961df833SKyungmin Park * the data size. In case of a dynamic volume it is more difficult - we
1141961df833SKyungmin Park * have to read the contents, cut 0xFF bytes from the end and copy only
1142961df833SKyungmin Park * the first part. We must do this to avoid writing 0xFF bytes as it
1143961df833SKyungmin Park * may have some side-effects. And not only this. It is important not
1144961df833SKyungmin Park * to include those 0xFFs to CRC because later the they may be filled
1145961df833SKyungmin Park * by data.
1146961df833SKyungmin Park */
1147961df833SKyungmin Park if (vid_hdr->vol_type == UBI_VID_DYNAMIC)
1148961df833SKyungmin Park aldata_size = data_size =
1149ff94bc40SHeiko Schocher ubi_calc_data_len(ubi, ubi->peb_buf, data_size);
1150961df833SKyungmin Park
1151961df833SKyungmin Park cond_resched();
1152ff94bc40SHeiko Schocher crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
1153961df833SKyungmin Park cond_resched();
1154961df833SKyungmin Park
1155961df833SKyungmin Park /*
1156ff94bc40SHeiko Schocher * It may turn out to be that the whole @from physical eraseblock
1157961df833SKyungmin Park * contains only 0xFF bytes. Then we have to only write the VID header
1158961df833SKyungmin Park * and do not write any data. This also means we should not set
1159961df833SKyungmin Park * @vid_hdr->copy_flag, @vid_hdr->data_size, and @vid_hdr->data_crc.
1160961df833SKyungmin Park */
1161961df833SKyungmin Park if (data_size > 0) {
1162961df833SKyungmin Park vid_hdr->copy_flag = 1;
1163961df833SKyungmin Park vid_hdr->data_size = cpu_to_be32(data_size);
1164961df833SKyungmin Park vid_hdr->data_crc = cpu_to_be32(crc);
1165961df833SKyungmin Park }
1166ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1167961df833SKyungmin Park
1168961df833SKyungmin Park err = ubi_io_write_vid_hdr(ubi, to, vid_hdr);
1169ff94bc40SHeiko Schocher if (err) {
1170ff94bc40SHeiko Schocher if (err == -EIO)
1171ff94bc40SHeiko Schocher err = MOVE_TARGET_WR_ERR;
1172961df833SKyungmin Park goto out_unlock_buf;
1173ff94bc40SHeiko Schocher }
1174961df833SKyungmin Park
1175961df833SKyungmin Park cond_resched();
1176961df833SKyungmin Park
1177961df833SKyungmin Park /* Read the VID header back and check if it was written correctly */
1178961df833SKyungmin Park err = ubi_io_read_vid_hdr(ubi, to, vid_hdr, 1);
1179961df833SKyungmin Park if (err) {
1180ff94bc40SHeiko Schocher if (err != UBI_IO_BITFLIPS) {
11810195a7bbSHeiko Schocher ubi_warn(ubi, "error %d while reading VID header back from PEB %d",
1182ff94bc40SHeiko Schocher err, to);
1183ff94bc40SHeiko Schocher if (is_error_sane(err))
1184ff94bc40SHeiko Schocher err = MOVE_TARGET_RD_ERR;
1185ff94bc40SHeiko Schocher } else
1186ff94bc40SHeiko Schocher err = MOVE_TARGET_BITFLIPS;
1187961df833SKyungmin Park goto out_unlock_buf;
1188961df833SKyungmin Park }
1189961df833SKyungmin Park
1190961df833SKyungmin Park if (data_size > 0) {
1191ff94bc40SHeiko Schocher err = ubi_io_write_data(ubi, ubi->peb_buf, to, 0, aldata_size);
1192ff94bc40SHeiko Schocher if (err) {
1193ff94bc40SHeiko Schocher if (err == -EIO)
1194ff94bc40SHeiko Schocher err = MOVE_TARGET_WR_ERR;
1195961df833SKyungmin Park goto out_unlock_buf;
1196ff94bc40SHeiko Schocher }
1197961df833SKyungmin Park
1198961df833SKyungmin Park cond_resched();
1199961df833SKyungmin Park
1200961df833SKyungmin Park /*
1201961df833SKyungmin Park * We've written the data and are going to read it back to make
1202961df833SKyungmin Park * sure it was written correctly.
1203961df833SKyungmin Park */
1204ff94bc40SHeiko Schocher memset(ubi->peb_buf, 0xFF, aldata_size);
1205ff94bc40SHeiko Schocher err = ubi_io_read_data(ubi, ubi->peb_buf, to, 0, aldata_size);
1206961df833SKyungmin Park if (err) {
1207ff94bc40SHeiko Schocher if (err != UBI_IO_BITFLIPS) {
12080195a7bbSHeiko Schocher ubi_warn(ubi, "error %d while reading data back from PEB %d",
1209ff94bc40SHeiko Schocher err, to);
1210ff94bc40SHeiko Schocher if (is_error_sane(err))
1211ff94bc40SHeiko Schocher err = MOVE_TARGET_RD_ERR;
1212ff94bc40SHeiko Schocher } else
1213ff94bc40SHeiko Schocher err = MOVE_TARGET_BITFLIPS;
1214961df833SKyungmin Park goto out_unlock_buf;
1215961df833SKyungmin Park }
1216961df833SKyungmin Park
1217961df833SKyungmin Park cond_resched();
1218961df833SKyungmin Park
1219ff94bc40SHeiko Schocher if (crc != crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size)) {
12200195a7bbSHeiko Schocher ubi_warn(ubi, "read data back from PEB %d and it is different",
1221961df833SKyungmin Park to);
1222ff94bc40SHeiko Schocher err = -EINVAL;
1223961df833SKyungmin Park goto out_unlock_buf;
1224961df833SKyungmin Park }
1225961df833SKyungmin Park }
1226961df833SKyungmin Park
1227961df833SKyungmin Park ubi_assert(vol->eba_tbl[lnum] == from);
12280195a7bbSHeiko Schocher down_read(&ubi->fm_eba_sem);
1229961df833SKyungmin Park vol->eba_tbl[lnum] = to;
12300195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
1231961df833SKyungmin Park
1232961df833SKyungmin Park out_unlock_buf:
1233961df833SKyungmin Park mutex_unlock(&ubi->buf_mutex);
1234961df833SKyungmin Park out_unlock_leb:
1235961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
1236961df833SKyungmin Park return err;
1237961df833SKyungmin Park }
1238961df833SKyungmin Park
1239961df833SKyungmin Park /**
1240ff94bc40SHeiko Schocher * print_rsvd_warning - warn about not having enough reserved PEBs.
1241961df833SKyungmin Park * @ubi: UBI device description object
1242ff94bc40SHeiko Schocher *
1243ff94bc40SHeiko Schocher * This is a helper function for 'ubi_eba_init()' which is called when UBI
1244ff94bc40SHeiko Schocher * cannot reserve enough PEBs for bad block handling. This function makes a
1245ff94bc40SHeiko Schocher * decision whether we have to print a warning or not. The algorithm is as
1246ff94bc40SHeiko Schocher * follows:
1247ff94bc40SHeiko Schocher * o if this is a new UBI image, then just print the warning
1248ff94bc40SHeiko Schocher * o if this is an UBI image which has already been used for some time, print
1249ff94bc40SHeiko Schocher * a warning only if we can reserve less than 10% of the expected amount of
1250ff94bc40SHeiko Schocher * the reserved PEB.
1251ff94bc40SHeiko Schocher *
1252ff94bc40SHeiko Schocher * The idea is that when UBI is used, PEBs become bad, and the reserved pool
1253ff94bc40SHeiko Schocher * of PEBs becomes smaller, which is normal and we do not want to scare users
1254ff94bc40SHeiko Schocher * with a warning every time they attach the MTD device. This was an issue
1255ff94bc40SHeiko Schocher * reported by real users.
1256ff94bc40SHeiko Schocher */
print_rsvd_warning(struct ubi_device * ubi,struct ubi_attach_info * ai)1257ff94bc40SHeiko Schocher static void print_rsvd_warning(struct ubi_device *ubi,
1258ff94bc40SHeiko Schocher struct ubi_attach_info *ai)
1259ff94bc40SHeiko Schocher {
1260ff94bc40SHeiko Schocher /*
1261ff94bc40SHeiko Schocher * The 1 << 18 (256KiB) number is picked randomly, just a reasonably
1262ff94bc40SHeiko Schocher * large number to distinguish between newly flashed and used images.
1263ff94bc40SHeiko Schocher */
1264ff94bc40SHeiko Schocher if (ai->max_sqnum > (1 << 18)) {
1265ff94bc40SHeiko Schocher int min = ubi->beb_rsvd_level / 10;
1266ff94bc40SHeiko Schocher
1267ff94bc40SHeiko Schocher if (!min)
1268ff94bc40SHeiko Schocher min = 1;
1269ff94bc40SHeiko Schocher if (ubi->beb_rsvd_pebs > min)
1270ff94bc40SHeiko Schocher return;
1271ff94bc40SHeiko Schocher }
1272ff94bc40SHeiko Schocher
12730195a7bbSHeiko Schocher ubi_warn(ubi, "cannot reserve enough PEBs for bad PEB handling, reserved %d, need %d",
1274ff94bc40SHeiko Schocher ubi->beb_rsvd_pebs, ubi->beb_rsvd_level);
1275ff94bc40SHeiko Schocher if (ubi->corr_peb_count)
12760195a7bbSHeiko Schocher ubi_warn(ubi, "%d PEBs are corrupted and not used",
1277ff94bc40SHeiko Schocher ubi->corr_peb_count);
1278ff94bc40SHeiko Schocher }
1279ff94bc40SHeiko Schocher
1280ff94bc40SHeiko Schocher /**
1281ff94bc40SHeiko Schocher * self_check_eba - run a self check on the EBA table constructed by fastmap.
1282ff94bc40SHeiko Schocher * @ubi: UBI device description object
1283ff94bc40SHeiko Schocher * @ai_fastmap: UBI attach info object created by fastmap
1284ff94bc40SHeiko Schocher * @ai_scan: UBI attach info object created by scanning
1285ff94bc40SHeiko Schocher *
1286ff94bc40SHeiko Schocher * Returns < 0 in case of an internal error, 0 otherwise.
1287ff94bc40SHeiko Schocher * If a bad EBA table entry was found it will be printed out and
1288ff94bc40SHeiko Schocher * ubi_assert() triggers.
1289ff94bc40SHeiko Schocher */
self_check_eba(struct ubi_device * ubi,struct ubi_attach_info * ai_fastmap,struct ubi_attach_info * ai_scan)1290ff94bc40SHeiko Schocher int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
1291ff94bc40SHeiko Schocher struct ubi_attach_info *ai_scan)
1292ff94bc40SHeiko Schocher {
1293ff94bc40SHeiko Schocher int i, j, num_volumes, ret = 0;
1294ff94bc40SHeiko Schocher int **scan_eba, **fm_eba;
1295ff94bc40SHeiko Schocher struct ubi_ainf_volume *av;
1296ff94bc40SHeiko Schocher struct ubi_volume *vol;
1297ff94bc40SHeiko Schocher struct ubi_ainf_peb *aeb;
1298ff94bc40SHeiko Schocher struct rb_node *rb;
1299ff94bc40SHeiko Schocher
1300ff94bc40SHeiko Schocher num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1301ff94bc40SHeiko Schocher
1302ff94bc40SHeiko Schocher scan_eba = kmalloc(sizeof(*scan_eba) * num_volumes, GFP_KERNEL);
1303ff94bc40SHeiko Schocher if (!scan_eba)
1304ff94bc40SHeiko Schocher return -ENOMEM;
1305ff94bc40SHeiko Schocher
1306ff94bc40SHeiko Schocher fm_eba = kmalloc(sizeof(*fm_eba) * num_volumes, GFP_KERNEL);
1307ff94bc40SHeiko Schocher if (!fm_eba) {
1308ff94bc40SHeiko Schocher kfree(scan_eba);
1309ff94bc40SHeiko Schocher return -ENOMEM;
1310ff94bc40SHeiko Schocher }
1311ff94bc40SHeiko Schocher
1312ff94bc40SHeiko Schocher for (i = 0; i < num_volumes; i++) {
1313ff94bc40SHeiko Schocher vol = ubi->volumes[i];
1314ff94bc40SHeiko Schocher if (!vol)
1315ff94bc40SHeiko Schocher continue;
1316ff94bc40SHeiko Schocher
1317ff94bc40SHeiko Schocher scan_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**scan_eba),
1318ff94bc40SHeiko Schocher GFP_KERNEL);
1319ff94bc40SHeiko Schocher if (!scan_eba[i]) {
1320ff94bc40SHeiko Schocher ret = -ENOMEM;
1321ff94bc40SHeiko Schocher goto out_free;
1322ff94bc40SHeiko Schocher }
1323ff94bc40SHeiko Schocher
1324ff94bc40SHeiko Schocher fm_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**fm_eba),
1325ff94bc40SHeiko Schocher GFP_KERNEL);
1326ff94bc40SHeiko Schocher if (!fm_eba[i]) {
1327ff94bc40SHeiko Schocher ret = -ENOMEM;
1328ff94bc40SHeiko Schocher goto out_free;
1329ff94bc40SHeiko Schocher }
1330ff94bc40SHeiko Schocher
1331ff94bc40SHeiko Schocher for (j = 0; j < vol->reserved_pebs; j++)
1332ff94bc40SHeiko Schocher scan_eba[i][j] = fm_eba[i][j] = UBI_LEB_UNMAPPED;
1333ff94bc40SHeiko Schocher
1334ff94bc40SHeiko Schocher av = ubi_find_av(ai_scan, idx2vol_id(ubi, i));
1335ff94bc40SHeiko Schocher if (!av)
1336ff94bc40SHeiko Schocher continue;
1337ff94bc40SHeiko Schocher
1338ff94bc40SHeiko Schocher ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1339ff94bc40SHeiko Schocher scan_eba[i][aeb->lnum] = aeb->pnum;
1340ff94bc40SHeiko Schocher
1341ff94bc40SHeiko Schocher av = ubi_find_av(ai_fastmap, idx2vol_id(ubi, i));
1342ff94bc40SHeiko Schocher if (!av)
1343ff94bc40SHeiko Schocher continue;
1344ff94bc40SHeiko Schocher
1345ff94bc40SHeiko Schocher ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1346ff94bc40SHeiko Schocher fm_eba[i][aeb->lnum] = aeb->pnum;
1347ff94bc40SHeiko Schocher
1348ff94bc40SHeiko Schocher for (j = 0; j < vol->reserved_pebs; j++) {
1349ff94bc40SHeiko Schocher if (scan_eba[i][j] != fm_eba[i][j]) {
1350ff94bc40SHeiko Schocher if (scan_eba[i][j] == UBI_LEB_UNMAPPED ||
1351ff94bc40SHeiko Schocher fm_eba[i][j] == UBI_LEB_UNMAPPED)
1352ff94bc40SHeiko Schocher continue;
1353ff94bc40SHeiko Schocher
13540195a7bbSHeiko Schocher ubi_err(ubi, "LEB:%i:%i is PEB:%i instead of %i!",
1355ff94bc40SHeiko Schocher vol->vol_id, i, fm_eba[i][j],
1356ff94bc40SHeiko Schocher scan_eba[i][j]);
1357ff94bc40SHeiko Schocher ubi_assert(0);
1358ff94bc40SHeiko Schocher }
1359ff94bc40SHeiko Schocher }
1360ff94bc40SHeiko Schocher }
1361ff94bc40SHeiko Schocher
1362ff94bc40SHeiko Schocher out_free:
1363ff94bc40SHeiko Schocher for (i = 0; i < num_volumes; i++) {
1364ff94bc40SHeiko Schocher if (!ubi->volumes[i])
1365ff94bc40SHeiko Schocher continue;
1366ff94bc40SHeiko Schocher
1367ff94bc40SHeiko Schocher kfree(scan_eba[i]);
1368ff94bc40SHeiko Schocher kfree(fm_eba[i]);
1369ff94bc40SHeiko Schocher }
1370ff94bc40SHeiko Schocher
1371ff94bc40SHeiko Schocher kfree(scan_eba);
1372ff94bc40SHeiko Schocher kfree(fm_eba);
1373ff94bc40SHeiko Schocher return ret;
1374ff94bc40SHeiko Schocher }
1375ff94bc40SHeiko Schocher
1376ff94bc40SHeiko Schocher /**
1377ff94bc40SHeiko Schocher * ubi_eba_init - initialize the EBA sub-system using attaching information.
1378ff94bc40SHeiko Schocher * @ubi: UBI device description object
1379ff94bc40SHeiko Schocher * @ai: attaching information
1380961df833SKyungmin Park *
1381961df833SKyungmin Park * This function returns zero in case of success and a negative error code in
1382961df833SKyungmin Park * case of failure.
1383961df833SKyungmin Park */
ubi_eba_init(struct ubi_device * ubi,struct ubi_attach_info * ai)1384ff94bc40SHeiko Schocher int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
1385961df833SKyungmin Park {
1386961df833SKyungmin Park int i, j, err, num_volumes;
1387ff94bc40SHeiko Schocher struct ubi_ainf_volume *av;
1388961df833SKyungmin Park struct ubi_volume *vol;
1389ff94bc40SHeiko Schocher struct ubi_ainf_peb *aeb;
1390961df833SKyungmin Park struct rb_node *rb;
1391961df833SKyungmin Park
1392ff94bc40SHeiko Schocher dbg_eba("initialize EBA sub-system");
1393961df833SKyungmin Park
1394961df833SKyungmin Park spin_lock_init(&ubi->ltree_lock);
1395961df833SKyungmin Park mutex_init(&ubi->alc_mutex);
1396961df833SKyungmin Park ubi->ltree = RB_ROOT;
1397961df833SKyungmin Park
1398ff94bc40SHeiko Schocher ubi->global_sqnum = ai->max_sqnum + 1;
1399961df833SKyungmin Park num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1400961df833SKyungmin Park
1401961df833SKyungmin Park for (i = 0; i < num_volumes; i++) {
1402961df833SKyungmin Park vol = ubi->volumes[i];
1403961df833SKyungmin Park if (!vol)
1404961df833SKyungmin Park continue;
1405961df833SKyungmin Park
1406961df833SKyungmin Park cond_resched();
1407961df833SKyungmin Park
1408961df833SKyungmin Park vol->eba_tbl = kmalloc(vol->reserved_pebs * sizeof(int),
1409961df833SKyungmin Park GFP_KERNEL);
1410961df833SKyungmin Park if (!vol->eba_tbl) {
1411961df833SKyungmin Park err = -ENOMEM;
1412961df833SKyungmin Park goto out_free;
1413961df833SKyungmin Park }
1414961df833SKyungmin Park
1415961df833SKyungmin Park for (j = 0; j < vol->reserved_pebs; j++)
1416961df833SKyungmin Park vol->eba_tbl[j] = UBI_LEB_UNMAPPED;
1417961df833SKyungmin Park
1418ff94bc40SHeiko Schocher av = ubi_find_av(ai, idx2vol_id(ubi, i));
1419ff94bc40SHeiko Schocher if (!av)
1420961df833SKyungmin Park continue;
1421961df833SKyungmin Park
1422ff94bc40SHeiko Schocher ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
1423ff94bc40SHeiko Schocher if (aeb->lnum >= vol->reserved_pebs)
1424961df833SKyungmin Park /*
1425961df833SKyungmin Park * This may happen in case of an unclean reboot
1426961df833SKyungmin Park * during re-size.
1427961df833SKyungmin Park */
1428ff94bc40SHeiko Schocher ubi_move_aeb_to_list(av, aeb, &ai->erase);
14290195a7bbSHeiko Schocher else
1430ff94bc40SHeiko Schocher vol->eba_tbl[aeb->lnum] = aeb->pnum;
1431961df833SKyungmin Park }
1432961df833SKyungmin Park }
1433961df833SKyungmin Park
1434961df833SKyungmin Park if (ubi->avail_pebs < EBA_RESERVED_PEBS) {
14350195a7bbSHeiko Schocher ubi_err(ubi, "no enough physical eraseblocks (%d, need %d)",
1436961df833SKyungmin Park ubi->avail_pebs, EBA_RESERVED_PEBS);
1437ff94bc40SHeiko Schocher if (ubi->corr_peb_count)
14380195a7bbSHeiko Schocher ubi_err(ubi, "%d PEBs are corrupted and not used",
1439ff94bc40SHeiko Schocher ubi->corr_peb_count);
1440961df833SKyungmin Park err = -ENOSPC;
1441961df833SKyungmin Park goto out_free;
1442961df833SKyungmin Park }
1443961df833SKyungmin Park ubi->avail_pebs -= EBA_RESERVED_PEBS;
1444961df833SKyungmin Park ubi->rsvd_pebs += EBA_RESERVED_PEBS;
1445961df833SKyungmin Park
1446961df833SKyungmin Park if (ubi->bad_allowed) {
1447961df833SKyungmin Park ubi_calculate_reserved(ubi);
1448961df833SKyungmin Park
1449961df833SKyungmin Park if (ubi->avail_pebs < ubi->beb_rsvd_level) {
1450961df833SKyungmin Park /* No enough free physical eraseblocks */
1451961df833SKyungmin Park ubi->beb_rsvd_pebs = ubi->avail_pebs;
1452ff94bc40SHeiko Schocher print_rsvd_warning(ubi, ai);
1453961df833SKyungmin Park } else
1454961df833SKyungmin Park ubi->beb_rsvd_pebs = ubi->beb_rsvd_level;
1455961df833SKyungmin Park
1456961df833SKyungmin Park ubi->avail_pebs -= ubi->beb_rsvd_pebs;
1457961df833SKyungmin Park ubi->rsvd_pebs += ubi->beb_rsvd_pebs;
1458961df833SKyungmin Park }
1459961df833SKyungmin Park
1460ff94bc40SHeiko Schocher dbg_eba("EBA sub-system is initialized");
1461961df833SKyungmin Park return 0;
1462961df833SKyungmin Park
1463961df833SKyungmin Park out_free:
1464961df833SKyungmin Park for (i = 0; i < num_volumes; i++) {
1465961df833SKyungmin Park if (!ubi->volumes[i])
1466961df833SKyungmin Park continue;
1467961df833SKyungmin Park kfree(ubi->volumes[i]->eba_tbl);
1468ff94bc40SHeiko Schocher ubi->volumes[i]->eba_tbl = NULL;
1469961df833SKyungmin Park }
1470961df833SKyungmin Park return err;
1471961df833SKyungmin Park }
1472