1961df833SKyungmin Park /*
2961df833SKyungmin Park * Copyright (c) International Business Machines Corp., 2006
3961df833SKyungmin Park *
41a459660SWolfgang Denk * SPDX-License-Identifier: GPL-2.0+
5961df833SKyungmin Park *
6961df833SKyungmin Park * Author: Artem Bityutskiy (Битюцкий Артём)
7961df833SKyungmin Park */
8961df833SKyungmin Park
9961df833SKyungmin Park /*
10ff94bc40SHeiko Schocher * The UBI Eraseblock Association (EBA) sub-system.
11961df833SKyungmin Park *
12ff94bc40SHeiko Schocher * This sub-system is responsible for I/O to/from logical eraseblock.
13961df833SKyungmin Park *
14961df833SKyungmin Park * Although in this implementation the EBA table is fully kept and managed in
15961df833SKyungmin Park * RAM, which assumes poor scalability, it might be (partially) maintained on
16961df833SKyungmin Park * flash in future implementations.
17961df833SKyungmin Park *
18ff94bc40SHeiko Schocher * The EBA sub-system implements per-logical eraseblock locking. Before
19ff94bc40SHeiko Schocher * accessing a logical eraseblock it is locked for reading or writing. The
20ff94bc40SHeiko Schocher * per-logical eraseblock locking is implemented by means of the lock tree. The
21ff94bc40SHeiko Schocher * lock tree is an RB-tree which refers all the currently locked logical
22ff94bc40SHeiko Schocher * eraseblocks. The lock tree elements are &struct ubi_ltree_entry objects.
23ff94bc40SHeiko Schocher * They are indexed by (@vol_id, @lnum) pairs.
24961df833SKyungmin Park *
25961df833SKyungmin Park * EBA also maintains the global sequence counter which is incremented each
26961df833SKyungmin Park * time a logical eraseblock is mapped to a physical eraseblock and it is
27961df833SKyungmin Park * stored in the volume identifier header. This means that each VID header has
28961df833SKyungmin Park * a unique sequence number. The sequence number is only increased an we assume
29961df833SKyungmin Park * 64 bits is enough to never overflow.
30961df833SKyungmin Park */
31961df833SKyungmin Park
32ff94bc40SHeiko Schocher #ifndef __UBOOT__
33961df833SKyungmin Park #include <linux/slab.h>
34961df833SKyungmin Park #include <linux/crc32.h>
35ff94bc40SHeiko Schocher #else
36ff94bc40SHeiko Schocher #include <ubi_uboot.h>
37961df833SKyungmin Park #endif
38961df833SKyungmin Park
39ff94bc40SHeiko Schocher #include <linux/err.h>
40961df833SKyungmin Park #include "ubi.h"
41961df833SKyungmin Park
42961df833SKyungmin Park /* Number of physical eraseblocks reserved for atomic LEB change operation */
43961df833SKyungmin Park #define EBA_RESERVED_PEBS 1
44961df833SKyungmin Park
45961df833SKyungmin Park /**
46961df833SKyungmin Park * next_sqnum - get next sequence number.
47961df833SKyungmin Park * @ubi: UBI device description object
48961df833SKyungmin Park *
49961df833SKyungmin Park * This function returns next sequence number to use, which is just the current
50961df833SKyungmin Park * global sequence counter value. It also increases the global sequence
51961df833SKyungmin Park * counter.
52961df833SKyungmin Park */
ubi_next_sqnum(struct ubi_device * ubi)53ff94bc40SHeiko Schocher unsigned long long ubi_next_sqnum(struct ubi_device *ubi)
54961df833SKyungmin Park {
55961df833SKyungmin Park unsigned long long sqnum;
56961df833SKyungmin Park
57961df833SKyungmin Park spin_lock(&ubi->ltree_lock);
58961df833SKyungmin Park sqnum = ubi->global_sqnum++;
59961df833SKyungmin Park spin_unlock(&ubi->ltree_lock);
60961df833SKyungmin Park
61961df833SKyungmin Park return sqnum;
62961df833SKyungmin Park }
63961df833SKyungmin Park
64961df833SKyungmin Park /**
65961df833SKyungmin Park * ubi_get_compat - get compatibility flags of a volume.
66961df833SKyungmin Park * @ubi: UBI device description object
67961df833SKyungmin Park * @vol_id: volume ID
68961df833SKyungmin Park *
69961df833SKyungmin Park * This function returns compatibility flags for an internal volume. User
70961df833SKyungmin Park * volumes have no compatibility flags, so %0 is returned.
71961df833SKyungmin Park */
ubi_get_compat(const struct ubi_device * ubi,int vol_id)72961df833SKyungmin Park static int ubi_get_compat(const struct ubi_device *ubi, int vol_id)
73961df833SKyungmin Park {
74961df833SKyungmin Park if (vol_id == UBI_LAYOUT_VOLUME_ID)
75961df833SKyungmin Park return UBI_LAYOUT_VOLUME_COMPAT;
76961df833SKyungmin Park return 0;
77961df833SKyungmin Park }
78961df833SKyungmin Park
79961df833SKyungmin Park /**
80961df833SKyungmin Park * ltree_lookup - look up the lock tree.
81961df833SKyungmin Park * @ubi: UBI device description object
82961df833SKyungmin Park * @vol_id: volume ID
83961df833SKyungmin Park * @lnum: logical eraseblock number
84961df833SKyungmin Park *
85961df833SKyungmin Park * This function returns a pointer to the corresponding &struct ubi_ltree_entry
86961df833SKyungmin Park * object if the logical eraseblock is locked and %NULL if it is not.
87961df833SKyungmin Park * @ubi->ltree_lock has to be locked.
88961df833SKyungmin Park */
ltree_lookup(struct ubi_device * ubi,int vol_id,int lnum)89961df833SKyungmin Park static struct ubi_ltree_entry *ltree_lookup(struct ubi_device *ubi, int vol_id,
90961df833SKyungmin Park int lnum)
91961df833SKyungmin Park {
92961df833SKyungmin Park struct rb_node *p;
93961df833SKyungmin Park
94961df833SKyungmin Park p = ubi->ltree.rb_node;
95961df833SKyungmin Park while (p) {
96961df833SKyungmin Park struct ubi_ltree_entry *le;
97961df833SKyungmin Park
98961df833SKyungmin Park le = rb_entry(p, struct ubi_ltree_entry, rb);
99961df833SKyungmin Park
100961df833SKyungmin Park if (vol_id < le->vol_id)
101961df833SKyungmin Park p = p->rb_left;
102961df833SKyungmin Park else if (vol_id > le->vol_id)
103961df833SKyungmin Park p = p->rb_right;
104961df833SKyungmin Park else {
105961df833SKyungmin Park if (lnum < le->lnum)
106961df833SKyungmin Park p = p->rb_left;
107961df833SKyungmin Park else if (lnum > le->lnum)
108961df833SKyungmin Park p = p->rb_right;
109961df833SKyungmin Park else
110961df833SKyungmin Park return le;
111961df833SKyungmin Park }
112961df833SKyungmin Park }
113961df833SKyungmin Park
114961df833SKyungmin Park return NULL;
115961df833SKyungmin Park }
116961df833SKyungmin Park
117961df833SKyungmin Park /**
118961df833SKyungmin Park * ltree_add_entry - add new entry to the lock tree.
119961df833SKyungmin Park * @ubi: UBI device description object
120961df833SKyungmin Park * @vol_id: volume ID
121961df833SKyungmin Park * @lnum: logical eraseblock number
122961df833SKyungmin Park *
123961df833SKyungmin Park * This function adds new entry for logical eraseblock (@vol_id, @lnum) to the
124961df833SKyungmin Park * lock tree. If such entry is already there, its usage counter is increased.
125961df833SKyungmin Park * Returns pointer to the lock tree entry or %-ENOMEM if memory allocation
126961df833SKyungmin Park * failed.
127961df833SKyungmin Park */
ltree_add_entry(struct ubi_device * ubi,int vol_id,int lnum)128961df833SKyungmin Park static struct ubi_ltree_entry *ltree_add_entry(struct ubi_device *ubi,
129961df833SKyungmin Park int vol_id, int lnum)
130961df833SKyungmin Park {
131961df833SKyungmin Park struct ubi_ltree_entry *le, *le1, *le_free;
132961df833SKyungmin Park
133961df833SKyungmin Park le = kmalloc(sizeof(struct ubi_ltree_entry), GFP_NOFS);
134961df833SKyungmin Park if (!le)
135961df833SKyungmin Park return ERR_PTR(-ENOMEM);
136961df833SKyungmin Park
137961df833SKyungmin Park le->users = 0;
138961df833SKyungmin Park init_rwsem(&le->mutex);
139961df833SKyungmin Park le->vol_id = vol_id;
140961df833SKyungmin Park le->lnum = lnum;
141961df833SKyungmin Park
142961df833SKyungmin Park spin_lock(&ubi->ltree_lock);
143961df833SKyungmin Park le1 = ltree_lookup(ubi, vol_id, lnum);
144961df833SKyungmin Park
145961df833SKyungmin Park if (le1) {
146961df833SKyungmin Park /*
147961df833SKyungmin Park * This logical eraseblock is already locked. The newly
148961df833SKyungmin Park * allocated lock entry is not needed.
149961df833SKyungmin Park */
150961df833SKyungmin Park le_free = le;
151961df833SKyungmin Park le = le1;
152961df833SKyungmin Park } else {
153961df833SKyungmin Park struct rb_node **p, *parent = NULL;
154961df833SKyungmin Park
155961df833SKyungmin Park /*
156961df833SKyungmin Park * No lock entry, add the newly allocated one to the
157961df833SKyungmin Park * @ubi->ltree RB-tree.
158961df833SKyungmin Park */
159961df833SKyungmin Park le_free = NULL;
160961df833SKyungmin Park
161961df833SKyungmin Park p = &ubi->ltree.rb_node;
162961df833SKyungmin Park while (*p) {
163961df833SKyungmin Park parent = *p;
164961df833SKyungmin Park le1 = rb_entry(parent, struct ubi_ltree_entry, rb);
165961df833SKyungmin Park
166961df833SKyungmin Park if (vol_id < le1->vol_id)
167961df833SKyungmin Park p = &(*p)->rb_left;
168961df833SKyungmin Park else if (vol_id > le1->vol_id)
169961df833SKyungmin Park p = &(*p)->rb_right;
170961df833SKyungmin Park else {
171961df833SKyungmin Park ubi_assert(lnum != le1->lnum);
172961df833SKyungmin Park if (lnum < le1->lnum)
173961df833SKyungmin Park p = &(*p)->rb_left;
174961df833SKyungmin Park else
175961df833SKyungmin Park p = &(*p)->rb_right;
176961df833SKyungmin Park }
177961df833SKyungmin Park }
178961df833SKyungmin Park
179961df833SKyungmin Park rb_link_node(&le->rb, parent, p);
180961df833SKyungmin Park rb_insert_color(&le->rb, &ubi->ltree);
181961df833SKyungmin Park }
182961df833SKyungmin Park le->users += 1;
183961df833SKyungmin Park spin_unlock(&ubi->ltree_lock);
184961df833SKyungmin Park
185961df833SKyungmin Park kfree(le_free);
186961df833SKyungmin Park return le;
187961df833SKyungmin Park }
188961df833SKyungmin Park
189961df833SKyungmin Park /**
190961df833SKyungmin Park * leb_read_lock - lock logical eraseblock for reading.
191961df833SKyungmin Park * @ubi: UBI device description object
192961df833SKyungmin Park * @vol_id: volume ID
193961df833SKyungmin Park * @lnum: logical eraseblock number
194961df833SKyungmin Park *
195961df833SKyungmin Park * This function locks a logical eraseblock for reading. Returns zero in case
196961df833SKyungmin Park * of success and a negative error code in case of failure.
197961df833SKyungmin Park */
leb_read_lock(struct ubi_device * ubi,int vol_id,int lnum)198961df833SKyungmin Park static int leb_read_lock(struct ubi_device *ubi, int vol_id, int lnum)
199961df833SKyungmin Park {
200961df833SKyungmin Park struct ubi_ltree_entry *le;
201961df833SKyungmin Park
202961df833SKyungmin Park le = ltree_add_entry(ubi, vol_id, lnum);
203961df833SKyungmin Park if (IS_ERR(le))
204961df833SKyungmin Park return PTR_ERR(le);
205961df833SKyungmin Park down_read(&le->mutex);
206961df833SKyungmin Park return 0;
207961df833SKyungmin Park }
208961df833SKyungmin Park
209961df833SKyungmin Park /**
210961df833SKyungmin Park * leb_read_unlock - unlock logical eraseblock.
211961df833SKyungmin Park * @ubi: UBI device description object
212961df833SKyungmin Park * @vol_id: volume ID
213961df833SKyungmin Park * @lnum: logical eraseblock number
214961df833SKyungmin Park */
leb_read_unlock(struct ubi_device * ubi,int vol_id,int lnum)215961df833SKyungmin Park static void leb_read_unlock(struct ubi_device *ubi, int vol_id, int lnum)
216961df833SKyungmin Park {
217961df833SKyungmin Park struct ubi_ltree_entry *le;
218961df833SKyungmin Park
219961df833SKyungmin Park spin_lock(&ubi->ltree_lock);
220961df833SKyungmin Park le = ltree_lookup(ubi, vol_id, lnum);
221961df833SKyungmin Park le->users -= 1;
222961df833SKyungmin Park ubi_assert(le->users >= 0);
223ff94bc40SHeiko Schocher up_read(&le->mutex);
224961df833SKyungmin Park if (le->users == 0) {
225961df833SKyungmin Park rb_erase(&le->rb, &ubi->ltree);
226ff94bc40SHeiko Schocher kfree(le);
227961df833SKyungmin Park }
228961df833SKyungmin Park spin_unlock(&ubi->ltree_lock);
229961df833SKyungmin Park }
230961df833SKyungmin Park
231961df833SKyungmin Park /**
232961df833SKyungmin Park * leb_write_lock - lock logical eraseblock for writing.
233961df833SKyungmin Park * @ubi: UBI device description object
234961df833SKyungmin Park * @vol_id: volume ID
235961df833SKyungmin Park * @lnum: logical eraseblock number
236961df833SKyungmin Park *
237961df833SKyungmin Park * This function locks a logical eraseblock for writing. Returns zero in case
238961df833SKyungmin Park * of success and a negative error code in case of failure.
239961df833SKyungmin Park */
leb_write_lock(struct ubi_device * ubi,int vol_id,int lnum)240961df833SKyungmin Park static int leb_write_lock(struct ubi_device *ubi, int vol_id, int lnum)
241961df833SKyungmin Park {
242961df833SKyungmin Park struct ubi_ltree_entry *le;
243961df833SKyungmin Park
244961df833SKyungmin Park le = ltree_add_entry(ubi, vol_id, lnum);
245961df833SKyungmin Park if (IS_ERR(le))
246961df833SKyungmin Park return PTR_ERR(le);
247961df833SKyungmin Park down_write(&le->mutex);
248961df833SKyungmin Park return 0;
249961df833SKyungmin Park }
250961df833SKyungmin Park
251961df833SKyungmin Park /**
252961df833SKyungmin Park * leb_write_lock - lock logical eraseblock for writing.
253961df833SKyungmin Park * @ubi: UBI device description object
254961df833SKyungmin Park * @vol_id: volume ID
255961df833SKyungmin Park * @lnum: logical eraseblock number
256961df833SKyungmin Park *
257961df833SKyungmin Park * This function locks a logical eraseblock for writing if there is no
258961df833SKyungmin Park * contention and does nothing if there is contention. Returns %0 in case of
259961df833SKyungmin Park * success, %1 in case of contention, and and a negative error code in case of
260961df833SKyungmin Park * failure.
261961df833SKyungmin Park */
leb_write_trylock(struct ubi_device * ubi,int vol_id,int lnum)262961df833SKyungmin Park static int leb_write_trylock(struct ubi_device *ubi, int vol_id, int lnum)
263961df833SKyungmin Park {
264961df833SKyungmin Park struct ubi_ltree_entry *le;
265961df833SKyungmin Park
266961df833SKyungmin Park le = ltree_add_entry(ubi, vol_id, lnum);
267961df833SKyungmin Park if (IS_ERR(le))
268961df833SKyungmin Park return PTR_ERR(le);
269961df833SKyungmin Park if (down_write_trylock(&le->mutex))
270961df833SKyungmin Park return 0;
271961df833SKyungmin Park
272961df833SKyungmin Park /* Contention, cancel */
273961df833SKyungmin Park spin_lock(&ubi->ltree_lock);
274961df833SKyungmin Park le->users -= 1;
275961df833SKyungmin Park ubi_assert(le->users >= 0);
276961df833SKyungmin Park if (le->users == 0) {
277961df833SKyungmin Park rb_erase(&le->rb, &ubi->ltree);
278961df833SKyungmin Park kfree(le);
279ff94bc40SHeiko Schocher }
280ff94bc40SHeiko Schocher spin_unlock(&ubi->ltree_lock);
281961df833SKyungmin Park
282961df833SKyungmin Park return 1;
283961df833SKyungmin Park }
284961df833SKyungmin Park
285961df833SKyungmin Park /**
286961df833SKyungmin Park * leb_write_unlock - unlock logical eraseblock.
287961df833SKyungmin Park * @ubi: UBI device description object
288961df833SKyungmin Park * @vol_id: volume ID
289961df833SKyungmin Park * @lnum: logical eraseblock number
290961df833SKyungmin Park */
leb_write_unlock(struct ubi_device * ubi,int vol_id,int lnum)291961df833SKyungmin Park static void leb_write_unlock(struct ubi_device *ubi, int vol_id, int lnum)
292961df833SKyungmin Park {
293961df833SKyungmin Park struct ubi_ltree_entry *le;
294961df833SKyungmin Park
295961df833SKyungmin Park spin_lock(&ubi->ltree_lock);
296961df833SKyungmin Park le = ltree_lookup(ubi, vol_id, lnum);
297961df833SKyungmin Park le->users -= 1;
298961df833SKyungmin Park ubi_assert(le->users >= 0);
299ff94bc40SHeiko Schocher up_write(&le->mutex);
300961df833SKyungmin Park if (le->users == 0) {
301961df833SKyungmin Park rb_erase(&le->rb, &ubi->ltree);
302961df833SKyungmin Park kfree(le);
303961df833SKyungmin Park }
304ff94bc40SHeiko Schocher spin_unlock(&ubi->ltree_lock);
305ff94bc40SHeiko Schocher }
306961df833SKyungmin Park
307961df833SKyungmin Park /**
308961df833SKyungmin Park * ubi_eba_unmap_leb - un-map logical eraseblock.
309961df833SKyungmin Park * @ubi: UBI device description object
310961df833SKyungmin Park * @vol: volume description object
311961df833SKyungmin Park * @lnum: logical eraseblock number
312961df833SKyungmin Park *
313961df833SKyungmin Park * This function un-maps logical eraseblock @lnum and schedules corresponding
314961df833SKyungmin Park * physical eraseblock for erasure. Returns zero in case of success and a
315961df833SKyungmin Park * negative error code in case of failure.
316961df833SKyungmin Park */
ubi_eba_unmap_leb(struct ubi_device * ubi,struct ubi_volume * vol,int lnum)317961df833SKyungmin Park int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
318961df833SKyungmin Park int lnum)
319961df833SKyungmin Park {
320961df833SKyungmin Park int err, pnum, vol_id = vol->vol_id;
321961df833SKyungmin Park
322961df833SKyungmin Park if (ubi->ro_mode)
323961df833SKyungmin Park return -EROFS;
324961df833SKyungmin Park
325961df833SKyungmin Park err = leb_write_lock(ubi, vol_id, lnum);
326961df833SKyungmin Park if (err)
327961df833SKyungmin Park return err;
328961df833SKyungmin Park
329961df833SKyungmin Park pnum = vol->eba_tbl[lnum];
330961df833SKyungmin Park if (pnum < 0)
331961df833SKyungmin Park /* This logical eraseblock is already unmapped */
332961df833SKyungmin Park goto out_unlock;
333961df833SKyungmin Park
334961df833SKyungmin Park dbg_eba("erase LEB %d:%d, PEB %d", vol_id, lnum, pnum);
335961df833SKyungmin Park
336*0195a7bbSHeiko Schocher down_read(&ubi->fm_eba_sem);
337961df833SKyungmin Park vol->eba_tbl[lnum] = UBI_LEB_UNMAPPED;
338*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
339ff94bc40SHeiko Schocher err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 0);
340961df833SKyungmin Park
341961df833SKyungmin Park out_unlock:
342961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
343961df833SKyungmin Park return err;
344961df833SKyungmin Park }
345961df833SKyungmin Park
346961df833SKyungmin Park /**
347961df833SKyungmin Park * ubi_eba_read_leb - read data.
348961df833SKyungmin Park * @ubi: UBI device description object
349961df833SKyungmin Park * @vol: volume description object
350961df833SKyungmin Park * @lnum: logical eraseblock number
351961df833SKyungmin Park * @buf: buffer to store the read data
352961df833SKyungmin Park * @offset: offset from where to read
353961df833SKyungmin Park * @len: how many bytes to read
354961df833SKyungmin Park * @check: data CRC check flag
355961df833SKyungmin Park *
356961df833SKyungmin Park * If the logical eraseblock @lnum is unmapped, @buf is filled with 0xFF
357961df833SKyungmin Park * bytes. The @check flag only makes sense for static volumes and forces
358961df833SKyungmin Park * eraseblock data CRC checking.
359961df833SKyungmin Park *
360961df833SKyungmin Park * In case of success this function returns zero. In case of a static volume,
361961df833SKyungmin Park * if data CRC mismatches - %-EBADMSG is returned. %-EBADMSG may also be
362961df833SKyungmin Park * returned for any volume type if an ECC error was detected by the MTD device
363961df833SKyungmin Park * driver. Other negative error cored may be returned in case of other errors.
364961df833SKyungmin Park */
ubi_eba_read_leb(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,void * buf,int offset,int len,int check)365961df833SKyungmin Park int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
366961df833SKyungmin Park void *buf, int offset, int len, int check)
367961df833SKyungmin Park {
368961df833SKyungmin Park int err, pnum, scrub = 0, vol_id = vol->vol_id;
369961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr;
370961df833SKyungmin Park uint32_t uninitialized_var(crc);
371961df833SKyungmin Park
372961df833SKyungmin Park err = leb_read_lock(ubi, vol_id, lnum);
373961df833SKyungmin Park if (err)
374961df833SKyungmin Park return err;
375961df833SKyungmin Park
376961df833SKyungmin Park pnum = vol->eba_tbl[lnum];
377961df833SKyungmin Park if (pnum < 0) {
378961df833SKyungmin Park /*
379961df833SKyungmin Park * The logical eraseblock is not mapped, fill the whole buffer
380961df833SKyungmin Park * with 0xFF bytes. The exception is static volumes for which
381961df833SKyungmin Park * it is an error to read unmapped logical eraseblocks.
382961df833SKyungmin Park */
383961df833SKyungmin Park dbg_eba("read %d bytes from offset %d of LEB %d:%d (unmapped)",
384961df833SKyungmin Park len, offset, vol_id, lnum);
385961df833SKyungmin Park leb_read_unlock(ubi, vol_id, lnum);
386961df833SKyungmin Park ubi_assert(vol->vol_type != UBI_STATIC_VOLUME);
387961df833SKyungmin Park memset(buf, 0xFF, len);
388961df833SKyungmin Park return 0;
389961df833SKyungmin Park }
390961df833SKyungmin Park
391961df833SKyungmin Park dbg_eba("read %d bytes from offset %d of LEB %d:%d, PEB %d",
392961df833SKyungmin Park len, offset, vol_id, lnum, pnum);
393961df833SKyungmin Park
394961df833SKyungmin Park if (vol->vol_type == UBI_DYNAMIC_VOLUME)
395961df833SKyungmin Park check = 0;
396961df833SKyungmin Park
397961df833SKyungmin Park retry:
398961df833SKyungmin Park if (check) {
399961df833SKyungmin Park vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
400961df833SKyungmin Park if (!vid_hdr) {
401961df833SKyungmin Park err = -ENOMEM;
402961df833SKyungmin Park goto out_unlock;
403961df833SKyungmin Park }
404961df833SKyungmin Park
405961df833SKyungmin Park err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
406961df833SKyungmin Park if (err && err != UBI_IO_BITFLIPS) {
407961df833SKyungmin Park if (err > 0) {
408961df833SKyungmin Park /*
409961df833SKyungmin Park * The header is either absent or corrupted.
410961df833SKyungmin Park * The former case means there is a bug -
411961df833SKyungmin Park * switch to read-only mode just in case.
412961df833SKyungmin Park * The latter case means a real corruption - we
413961df833SKyungmin Park * may try to recover data. FIXME: but this is
414961df833SKyungmin Park * not implemented.
415961df833SKyungmin Park */
416ff94bc40SHeiko Schocher if (err == UBI_IO_BAD_HDR_EBADMSG ||
417ff94bc40SHeiko Schocher err == UBI_IO_BAD_HDR) {
418*0195a7bbSHeiko Schocher ubi_warn(ubi, "corrupted VID header at PEB %d, LEB %d:%d",
419ff94bc40SHeiko Schocher pnum, vol_id, lnum);
420961df833SKyungmin Park err = -EBADMSG;
421*0195a7bbSHeiko Schocher } else {
422*0195a7bbSHeiko Schocher err = -EINVAL;
423961df833SKyungmin Park ubi_ro_mode(ubi);
424961df833SKyungmin Park }
425*0195a7bbSHeiko Schocher }
426961df833SKyungmin Park goto out_free;
427961df833SKyungmin Park } else if (err == UBI_IO_BITFLIPS)
428961df833SKyungmin Park scrub = 1;
429961df833SKyungmin Park
430961df833SKyungmin Park ubi_assert(lnum < be32_to_cpu(vid_hdr->used_ebs));
431961df833SKyungmin Park ubi_assert(len == be32_to_cpu(vid_hdr->data_size));
432961df833SKyungmin Park
433961df833SKyungmin Park crc = be32_to_cpu(vid_hdr->data_crc);
434961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
435961df833SKyungmin Park }
436961df833SKyungmin Park
437961df833SKyungmin Park err = ubi_io_read_data(ubi, buf, pnum, offset, len);
438961df833SKyungmin Park if (err) {
439*0195a7bbSHeiko Schocher if (err == UBI_IO_BITFLIPS)
440961df833SKyungmin Park scrub = 1;
441*0195a7bbSHeiko Schocher else if (mtd_is_eccerr(err)) {
442961df833SKyungmin Park if (vol->vol_type == UBI_DYNAMIC_VOLUME)
443961df833SKyungmin Park goto out_unlock;
444961df833SKyungmin Park scrub = 1;
445961df833SKyungmin Park if (!check) {
446*0195a7bbSHeiko Schocher ubi_msg(ubi, "force data checking");
447961df833SKyungmin Park check = 1;
448961df833SKyungmin Park goto retry;
449961df833SKyungmin Park }
450961df833SKyungmin Park } else
451961df833SKyungmin Park goto out_unlock;
452961df833SKyungmin Park }
453961df833SKyungmin Park
454961df833SKyungmin Park if (check) {
455961df833SKyungmin Park uint32_t crc1 = crc32(UBI_CRC32_INIT, buf, len);
456961df833SKyungmin Park if (crc1 != crc) {
457*0195a7bbSHeiko Schocher ubi_warn(ubi, "CRC error: calculated %#08x, must be %#08x",
458961df833SKyungmin Park crc1, crc);
459961df833SKyungmin Park err = -EBADMSG;
460961df833SKyungmin Park goto out_unlock;
461961df833SKyungmin Park }
462961df833SKyungmin Park }
463961df833SKyungmin Park
464961df833SKyungmin Park if (scrub)
465961df833SKyungmin Park err = ubi_wl_scrub_peb(ubi, pnum);
466961df833SKyungmin Park
467961df833SKyungmin Park leb_read_unlock(ubi, vol_id, lnum);
468961df833SKyungmin Park return err;
469961df833SKyungmin Park
470961df833SKyungmin Park out_free:
471961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
472961df833SKyungmin Park out_unlock:
473961df833SKyungmin Park leb_read_unlock(ubi, vol_id, lnum);
474961df833SKyungmin Park return err;
475961df833SKyungmin Park }
476961df833SKyungmin Park
477*0195a7bbSHeiko Schocher #ifndef __UBOOT__
478*0195a7bbSHeiko Schocher /**
479*0195a7bbSHeiko Schocher * ubi_eba_read_leb_sg - read data into a scatter gather list.
480*0195a7bbSHeiko Schocher * @ubi: UBI device description object
481*0195a7bbSHeiko Schocher * @vol: volume description object
482*0195a7bbSHeiko Schocher * @lnum: logical eraseblock number
483*0195a7bbSHeiko Schocher * @sgl: UBI scatter gather list to store the read data
484*0195a7bbSHeiko Schocher * @offset: offset from where to read
485*0195a7bbSHeiko Schocher * @len: how many bytes to read
486*0195a7bbSHeiko Schocher * @check: data CRC check flag
487*0195a7bbSHeiko Schocher *
488*0195a7bbSHeiko Schocher * This function works exactly like ubi_eba_read_leb(). But instead of
489*0195a7bbSHeiko Schocher * storing the read data into a buffer it writes to an UBI scatter gather
490*0195a7bbSHeiko Schocher * list.
491*0195a7bbSHeiko 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)492*0195a7bbSHeiko Schocher int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
493*0195a7bbSHeiko Schocher struct ubi_sgl *sgl, int lnum, int offset, int len,
494*0195a7bbSHeiko Schocher int check)
495*0195a7bbSHeiko Schocher {
496*0195a7bbSHeiko Schocher int to_read;
497*0195a7bbSHeiko Schocher int ret;
498*0195a7bbSHeiko Schocher struct scatterlist *sg;
499*0195a7bbSHeiko Schocher
500*0195a7bbSHeiko Schocher for (;;) {
501*0195a7bbSHeiko Schocher ubi_assert(sgl->list_pos < UBI_MAX_SG_COUNT);
502*0195a7bbSHeiko Schocher sg = &sgl->sg[sgl->list_pos];
503*0195a7bbSHeiko Schocher if (len < sg->length - sgl->page_pos)
504*0195a7bbSHeiko Schocher to_read = len;
505*0195a7bbSHeiko Schocher else
506*0195a7bbSHeiko Schocher to_read = sg->length - sgl->page_pos;
507*0195a7bbSHeiko Schocher
508*0195a7bbSHeiko Schocher ret = ubi_eba_read_leb(ubi, vol, lnum,
509*0195a7bbSHeiko Schocher sg_virt(sg) + sgl->page_pos, offset,
510*0195a7bbSHeiko Schocher to_read, check);
511*0195a7bbSHeiko Schocher if (ret < 0)
512*0195a7bbSHeiko Schocher return ret;
513*0195a7bbSHeiko Schocher
514*0195a7bbSHeiko Schocher offset += to_read;
515*0195a7bbSHeiko Schocher len -= to_read;
516*0195a7bbSHeiko Schocher if (!len) {
517*0195a7bbSHeiko Schocher sgl->page_pos += to_read;
518*0195a7bbSHeiko Schocher if (sgl->page_pos == sg->length) {
519*0195a7bbSHeiko Schocher sgl->list_pos++;
520*0195a7bbSHeiko Schocher sgl->page_pos = 0;
521*0195a7bbSHeiko Schocher }
522*0195a7bbSHeiko Schocher
523*0195a7bbSHeiko Schocher break;
524*0195a7bbSHeiko Schocher }
525*0195a7bbSHeiko Schocher
526*0195a7bbSHeiko Schocher sgl->list_pos++;
527*0195a7bbSHeiko Schocher sgl->page_pos = 0;
528*0195a7bbSHeiko Schocher }
529*0195a7bbSHeiko Schocher
530*0195a7bbSHeiko Schocher return ret;
531*0195a7bbSHeiko Schocher }
532*0195a7bbSHeiko Schocher #endif
533*0195a7bbSHeiko Schocher
534961df833SKyungmin Park /**
535961df833SKyungmin Park * recover_peb - recover from write failure.
536961df833SKyungmin Park * @ubi: UBI device description object
537961df833SKyungmin Park * @pnum: the physical eraseblock to recover
538961df833SKyungmin Park * @vol_id: volume ID
539961df833SKyungmin Park * @lnum: logical eraseblock number
540961df833SKyungmin Park * @buf: data which was not written because of the write failure
541961df833SKyungmin Park * @offset: offset of the failed write
542961df833SKyungmin Park * @len: how many bytes should have been written
543961df833SKyungmin Park *
544961df833SKyungmin Park * This function is called in case of a write failure and moves all good data
545961df833SKyungmin Park * from the potentially bad physical eraseblock to a good physical eraseblock.
546961df833SKyungmin Park * This function also writes the data which was not written due to the failure.
547961df833SKyungmin Park * Returns new physical eraseblock number in case of success, and a negative
548961df833SKyungmin Park * error code in case of failure.
549961df833SKyungmin Park */
recover_peb(struct ubi_device * ubi,int pnum,int vol_id,int lnum,const void * buf,int offset,int len)550961df833SKyungmin Park static int recover_peb(struct ubi_device *ubi, int pnum, int vol_id, int lnum,
551961df833SKyungmin Park const void *buf, int offset, int len)
552961df833SKyungmin Park {
553961df833SKyungmin Park int err, idx = vol_id2idx(ubi, vol_id), new_pnum, data_size, tries = 0;
554961df833SKyungmin Park struct ubi_volume *vol = ubi->volumes[idx];
555961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr;
556961df833SKyungmin Park
557961df833SKyungmin Park vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
558ff94bc40SHeiko Schocher if (!vid_hdr)
559961df833SKyungmin Park return -ENOMEM;
560961df833SKyungmin Park
561961df833SKyungmin Park retry:
562ff94bc40SHeiko Schocher new_pnum = ubi_wl_get_peb(ubi);
563961df833SKyungmin Park if (new_pnum < 0) {
564961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
565*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
566961df833SKyungmin Park return new_pnum;
567961df833SKyungmin Park }
568961df833SKyungmin Park
569*0195a7bbSHeiko Schocher ubi_msg(ubi, "recover PEB %d, move data to PEB %d",
570*0195a7bbSHeiko Schocher pnum, new_pnum);
571961df833SKyungmin Park
572961df833SKyungmin Park err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
573961df833SKyungmin Park if (err && err != UBI_IO_BITFLIPS) {
574961df833SKyungmin Park if (err > 0)
575961df833SKyungmin Park err = -EIO;
576*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
577961df833SKyungmin Park goto out_put;
578961df833SKyungmin Park }
579961df833SKyungmin Park
580ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
581961df833SKyungmin Park err = ubi_io_write_vid_hdr(ubi, new_pnum, vid_hdr);
582*0195a7bbSHeiko Schocher if (err) {
583*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
584961df833SKyungmin Park goto write_error;
585*0195a7bbSHeiko Schocher }
586961df833SKyungmin Park
587961df833SKyungmin Park data_size = offset + len;
588ff94bc40SHeiko Schocher mutex_lock(&ubi->buf_mutex);
589ff94bc40SHeiko Schocher memset(ubi->peb_buf + offset, 0xFF, len);
590961df833SKyungmin Park
591961df833SKyungmin Park /* Read everything before the area where the write failure happened */
592961df833SKyungmin Park if (offset > 0) {
593ff94bc40SHeiko Schocher err = ubi_io_read_data(ubi, ubi->peb_buf, pnum, 0, offset);
594*0195a7bbSHeiko Schocher if (err && err != UBI_IO_BITFLIPS) {
595*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
596ff94bc40SHeiko Schocher goto out_unlock;
597961df833SKyungmin Park }
598*0195a7bbSHeiko Schocher }
599961df833SKyungmin Park
600ff94bc40SHeiko Schocher memcpy(ubi->peb_buf + offset, buf, len);
601961df833SKyungmin Park
602ff94bc40SHeiko Schocher err = ubi_io_write_data(ubi, ubi->peb_buf, new_pnum, 0, data_size);
603ff94bc40SHeiko Schocher if (err) {
604ff94bc40SHeiko Schocher mutex_unlock(&ubi->buf_mutex);
605*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
606961df833SKyungmin Park goto write_error;
607ff94bc40SHeiko Schocher }
608961df833SKyungmin Park
609961df833SKyungmin Park mutex_unlock(&ubi->buf_mutex);
610961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
611961df833SKyungmin Park
612961df833SKyungmin Park vol->eba_tbl[lnum] = new_pnum;
613*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
614ff94bc40SHeiko Schocher ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
615961df833SKyungmin Park
616*0195a7bbSHeiko Schocher ubi_msg(ubi, "data was successfully recovered");
617961df833SKyungmin Park return 0;
618961df833SKyungmin Park
619ff94bc40SHeiko Schocher out_unlock:
620961df833SKyungmin Park mutex_unlock(&ubi->buf_mutex);
621ff94bc40SHeiko Schocher out_put:
622ff94bc40SHeiko Schocher ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
623961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
624961df833SKyungmin Park return err;
625961df833SKyungmin Park
626961df833SKyungmin Park write_error:
627961df833SKyungmin Park /*
628961df833SKyungmin Park * Bad luck? This physical eraseblock is bad too? Crud. Let's try to
629961df833SKyungmin Park * get another one.
630961df833SKyungmin Park */
631*0195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write to PEB %d", new_pnum);
632ff94bc40SHeiko Schocher ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
633961df833SKyungmin Park if (++tries > UBI_IO_RETRIES) {
634961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
635961df833SKyungmin Park return err;
636961df833SKyungmin Park }
637*0195a7bbSHeiko Schocher ubi_msg(ubi, "try again");
638961df833SKyungmin Park goto retry;
639961df833SKyungmin Park }
640961df833SKyungmin Park
641961df833SKyungmin Park /**
642961df833SKyungmin Park * ubi_eba_write_leb - write data to dynamic volume.
643961df833SKyungmin Park * @ubi: UBI device description object
644961df833SKyungmin Park * @vol: volume description object
645961df833SKyungmin Park * @lnum: logical eraseblock number
646961df833SKyungmin Park * @buf: the data to write
647961df833SKyungmin Park * @offset: offset within the logical eraseblock where to write
648961df833SKyungmin Park * @len: how many bytes to write
649961df833SKyungmin Park *
650961df833SKyungmin Park * This function writes data to logical eraseblock @lnum of a dynamic volume
651961df833SKyungmin Park * @vol. Returns zero in case of success and a negative error code in case
652961df833SKyungmin Park * of failure. In case of error, it is possible that something was still
653961df833SKyungmin Park * written to the flash media, but may be some garbage.
654961df833SKyungmin Park */
ubi_eba_write_leb(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,const void * buf,int offset,int len)655961df833SKyungmin Park int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
656ff94bc40SHeiko Schocher const void *buf, int offset, int len)
657961df833SKyungmin Park {
658961df833SKyungmin Park int err, pnum, tries = 0, vol_id = vol->vol_id;
659961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr;
660961df833SKyungmin Park
661961df833SKyungmin Park if (ubi->ro_mode)
662961df833SKyungmin Park return -EROFS;
663961df833SKyungmin Park
664961df833SKyungmin Park err = leb_write_lock(ubi, vol_id, lnum);
665961df833SKyungmin Park if (err)
666961df833SKyungmin Park return err;
667961df833SKyungmin Park
668961df833SKyungmin Park pnum = vol->eba_tbl[lnum];
669961df833SKyungmin Park if (pnum >= 0) {
670961df833SKyungmin Park dbg_eba("write %d bytes at offset %d of LEB %d:%d, PEB %d",
671961df833SKyungmin Park len, offset, vol_id, lnum, pnum);
672961df833SKyungmin Park
673961df833SKyungmin Park err = ubi_io_write_data(ubi, buf, pnum, offset, len);
674961df833SKyungmin Park if (err) {
675*0195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write data to PEB %d", pnum);
676961df833SKyungmin Park if (err == -EIO && ubi->bad_allowed)
677961df833SKyungmin Park err = recover_peb(ubi, pnum, vol_id, lnum, buf,
678961df833SKyungmin Park offset, len);
679961df833SKyungmin Park if (err)
680961df833SKyungmin Park ubi_ro_mode(ubi);
681961df833SKyungmin Park }
682961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
683961df833SKyungmin Park return err;
684961df833SKyungmin Park }
685961df833SKyungmin Park
686961df833SKyungmin Park /*
687961df833SKyungmin Park * The logical eraseblock is not mapped. We have to get a free physical
688961df833SKyungmin Park * eraseblock and write the volume identifier header there first.
689961df833SKyungmin Park */
690961df833SKyungmin Park vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
691961df833SKyungmin Park if (!vid_hdr) {
692961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
693961df833SKyungmin Park return -ENOMEM;
694961df833SKyungmin Park }
695961df833SKyungmin Park
696961df833SKyungmin Park vid_hdr->vol_type = UBI_VID_DYNAMIC;
697ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
698961df833SKyungmin Park vid_hdr->vol_id = cpu_to_be32(vol_id);
699961df833SKyungmin Park vid_hdr->lnum = cpu_to_be32(lnum);
700961df833SKyungmin Park vid_hdr->compat = ubi_get_compat(ubi, vol_id);
701961df833SKyungmin Park vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
702961df833SKyungmin Park
703961df833SKyungmin Park retry:
704ff94bc40SHeiko Schocher pnum = ubi_wl_get_peb(ubi);
705961df833SKyungmin Park if (pnum < 0) {
706961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
707961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
708*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
709961df833SKyungmin Park return pnum;
710961df833SKyungmin Park }
711961df833SKyungmin Park
712961df833SKyungmin Park dbg_eba("write VID hdr and %d bytes at offset %d of LEB %d:%d, PEB %d",
713961df833SKyungmin Park len, offset, vol_id, lnum, pnum);
714961df833SKyungmin Park
715961df833SKyungmin Park err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
716961df833SKyungmin Park if (err) {
717*0195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
718961df833SKyungmin Park vol_id, lnum, pnum);
719*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
720961df833SKyungmin Park goto write_error;
721961df833SKyungmin Park }
722961df833SKyungmin Park
723961df833SKyungmin Park if (len) {
724961df833SKyungmin Park err = ubi_io_write_data(ubi, buf, pnum, offset, len);
725961df833SKyungmin Park if (err) {
726*0195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write %d bytes at offset %d of LEB %d:%d, PEB %d",
727ff94bc40SHeiko Schocher len, offset, vol_id, lnum, pnum);
728*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
729961df833SKyungmin Park goto write_error;
730961df833SKyungmin Park }
731961df833SKyungmin Park }
732961df833SKyungmin Park
733961df833SKyungmin Park vol->eba_tbl[lnum] = pnum;
734*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
735961df833SKyungmin Park
736961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
737961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
738961df833SKyungmin Park return 0;
739961df833SKyungmin Park
740961df833SKyungmin Park write_error:
741961df833SKyungmin Park if (err != -EIO || !ubi->bad_allowed) {
742961df833SKyungmin Park ubi_ro_mode(ubi);
743961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
744961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
745961df833SKyungmin Park return err;
746961df833SKyungmin Park }
747961df833SKyungmin Park
748961df833SKyungmin Park /*
749961df833SKyungmin Park * Fortunately, this is the first write operation to this physical
750961df833SKyungmin Park * eraseblock, so just put it and request a new one. We assume that if
751961df833SKyungmin Park * this physical eraseblock went bad, the erase code will handle that.
752961df833SKyungmin Park */
753ff94bc40SHeiko Schocher err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
754961df833SKyungmin Park if (err || ++tries > UBI_IO_RETRIES) {
755961df833SKyungmin Park ubi_ro_mode(ubi);
756961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
757961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
758961df833SKyungmin Park return err;
759961df833SKyungmin Park }
760961df833SKyungmin Park
761ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
762*0195a7bbSHeiko Schocher ubi_msg(ubi, "try another PEB");
763961df833SKyungmin Park goto retry;
764961df833SKyungmin Park }
765961df833SKyungmin Park
766961df833SKyungmin Park /**
767961df833SKyungmin Park * ubi_eba_write_leb_st - write data to static volume.
768961df833SKyungmin Park * @ubi: UBI device description object
769961df833SKyungmin Park * @vol: volume description object
770961df833SKyungmin Park * @lnum: logical eraseblock number
771961df833SKyungmin Park * @buf: data to write
772961df833SKyungmin Park * @len: how many bytes to write
773961df833SKyungmin Park * @used_ebs: how many logical eraseblocks will this volume contain
774961df833SKyungmin Park *
775961df833SKyungmin Park * This function writes data to logical eraseblock @lnum of static volume
776961df833SKyungmin Park * @vol. The @used_ebs argument should contain total number of logical
777961df833SKyungmin Park * eraseblock in this static volume.
778961df833SKyungmin Park *
779961df833SKyungmin Park * When writing to the last logical eraseblock, the @len argument doesn't have
780961df833SKyungmin Park * to be aligned to the minimal I/O unit size. Instead, it has to be equivalent
781961df833SKyungmin Park * to the real data size, although the @buf buffer has to contain the
782961df833SKyungmin Park * alignment. In all other cases, @len has to be aligned.
783961df833SKyungmin Park *
784ff94bc40SHeiko Schocher * It is prohibited to write more than once to logical eraseblocks of static
785961df833SKyungmin Park * volumes. This function returns zero in case of success and a negative error
786961df833SKyungmin Park * code in case of failure.
787961df833SKyungmin Park */
ubi_eba_write_leb_st(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,const void * buf,int len,int used_ebs)788961df833SKyungmin Park int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
789ff94bc40SHeiko Schocher int lnum, const void *buf, int len, int used_ebs)
790961df833SKyungmin Park {
791961df833SKyungmin Park int err, pnum, tries = 0, data_size = len, vol_id = vol->vol_id;
792961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr;
793961df833SKyungmin Park uint32_t crc;
794961df833SKyungmin Park
795961df833SKyungmin Park if (ubi->ro_mode)
796961df833SKyungmin Park return -EROFS;
797961df833SKyungmin Park
798961df833SKyungmin Park if (lnum == used_ebs - 1)
799961df833SKyungmin Park /* If this is the last LEB @len may be unaligned */
800961df833SKyungmin Park len = ALIGN(data_size, ubi->min_io_size);
801961df833SKyungmin Park else
802961df833SKyungmin Park ubi_assert(!(len & (ubi->min_io_size - 1)));
803961df833SKyungmin Park
804961df833SKyungmin Park vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
805961df833SKyungmin Park if (!vid_hdr)
806961df833SKyungmin Park return -ENOMEM;
807961df833SKyungmin Park
808961df833SKyungmin Park err = leb_write_lock(ubi, vol_id, lnum);
809961df833SKyungmin Park if (err) {
810961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
811961df833SKyungmin Park return err;
812961df833SKyungmin Park }
813961df833SKyungmin Park
814ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
815961df833SKyungmin Park vid_hdr->vol_id = cpu_to_be32(vol_id);
816961df833SKyungmin Park vid_hdr->lnum = cpu_to_be32(lnum);
817961df833SKyungmin Park vid_hdr->compat = ubi_get_compat(ubi, vol_id);
818961df833SKyungmin Park vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
819961df833SKyungmin Park
820961df833SKyungmin Park crc = crc32(UBI_CRC32_INIT, buf, data_size);
821961df833SKyungmin Park vid_hdr->vol_type = UBI_VID_STATIC;
822961df833SKyungmin Park vid_hdr->data_size = cpu_to_be32(data_size);
823961df833SKyungmin Park vid_hdr->used_ebs = cpu_to_be32(used_ebs);
824961df833SKyungmin Park vid_hdr->data_crc = cpu_to_be32(crc);
825961df833SKyungmin Park
826961df833SKyungmin Park retry:
827ff94bc40SHeiko Schocher pnum = ubi_wl_get_peb(ubi);
828961df833SKyungmin Park if (pnum < 0) {
829961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
830961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
831*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
832961df833SKyungmin Park return pnum;
833961df833SKyungmin Park }
834961df833SKyungmin Park
835961df833SKyungmin Park dbg_eba("write VID hdr and %d bytes at LEB %d:%d, PEB %d, used_ebs %d",
836961df833SKyungmin Park len, vol_id, lnum, pnum, used_ebs);
837961df833SKyungmin Park
838961df833SKyungmin Park err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
839961df833SKyungmin Park if (err) {
840*0195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
841961df833SKyungmin Park vol_id, lnum, pnum);
842*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
843961df833SKyungmin Park goto write_error;
844961df833SKyungmin Park }
845961df833SKyungmin Park
846961df833SKyungmin Park err = ubi_io_write_data(ubi, buf, pnum, 0, len);
847961df833SKyungmin Park if (err) {
848*0195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
849961df833SKyungmin Park len, pnum);
850*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
851961df833SKyungmin Park goto write_error;
852961df833SKyungmin Park }
853961df833SKyungmin Park
854961df833SKyungmin Park ubi_assert(vol->eba_tbl[lnum] < 0);
855961df833SKyungmin Park vol->eba_tbl[lnum] = pnum;
856*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
857961df833SKyungmin Park
858961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
859961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
860961df833SKyungmin Park return 0;
861961df833SKyungmin Park
862961df833SKyungmin Park write_error:
863961df833SKyungmin Park if (err != -EIO || !ubi->bad_allowed) {
864961df833SKyungmin Park /*
865961df833SKyungmin Park * This flash device does not admit of bad eraseblocks or
866961df833SKyungmin Park * something nasty and unexpected happened. Switch to read-only
867961df833SKyungmin Park * mode just in case.
868961df833SKyungmin Park */
869961df833SKyungmin Park ubi_ro_mode(ubi);
870961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
871961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
872961df833SKyungmin Park return err;
873961df833SKyungmin Park }
874961df833SKyungmin Park
875ff94bc40SHeiko Schocher err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
876961df833SKyungmin Park if (err || ++tries > UBI_IO_RETRIES) {
877961df833SKyungmin Park ubi_ro_mode(ubi);
878961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
879961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
880961df833SKyungmin Park return err;
881961df833SKyungmin Park }
882961df833SKyungmin Park
883ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
884*0195a7bbSHeiko Schocher ubi_msg(ubi, "try another PEB");
885961df833SKyungmin Park goto retry;
886961df833SKyungmin Park }
887961df833SKyungmin Park
888961df833SKyungmin Park /*
889961df833SKyungmin Park * ubi_eba_atomic_leb_change - change logical eraseblock atomically.
890961df833SKyungmin Park * @ubi: UBI device description object
891961df833SKyungmin Park * @vol: volume description object
892961df833SKyungmin Park * @lnum: logical eraseblock number
893961df833SKyungmin Park * @buf: data to write
894961df833SKyungmin Park * @len: how many bytes to write
895961df833SKyungmin Park *
896961df833SKyungmin Park * This function changes the contents of a logical eraseblock atomically. @buf
897961df833SKyungmin Park * has to contain new logical eraseblock data, and @len - the length of the
898961df833SKyungmin Park * data, which has to be aligned. This function guarantees that in case of an
899961df833SKyungmin Park * unclean reboot the old contents is preserved. Returns zero in case of
900961df833SKyungmin Park * success and a negative error code in case of failure.
901961df833SKyungmin Park *
902961df833SKyungmin Park * UBI reserves one LEB for the "atomic LEB change" operation, so only one
903961df833SKyungmin Park * LEB change may be done at a time. This is ensured by @ubi->alc_mutex.
904961df833SKyungmin Park */
ubi_eba_atomic_leb_change(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,const void * buf,int len)905961df833SKyungmin Park int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
906ff94bc40SHeiko Schocher int lnum, const void *buf, int len)
907961df833SKyungmin Park {
908*0195a7bbSHeiko Schocher int err, pnum, old_pnum, tries = 0, vol_id = vol->vol_id;
909961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr;
910961df833SKyungmin Park uint32_t crc;
911961df833SKyungmin Park
912961df833SKyungmin Park if (ubi->ro_mode)
913961df833SKyungmin Park return -EROFS;
914961df833SKyungmin Park
915961df833SKyungmin Park if (len == 0) {
916961df833SKyungmin Park /*
917961df833SKyungmin Park * Special case when data length is zero. In this case the LEB
918961df833SKyungmin Park * has to be unmapped and mapped somewhere else.
919961df833SKyungmin Park */
920961df833SKyungmin Park err = ubi_eba_unmap_leb(ubi, vol, lnum);
921961df833SKyungmin Park if (err)
922961df833SKyungmin Park return err;
923ff94bc40SHeiko Schocher return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0);
924961df833SKyungmin Park }
925961df833SKyungmin Park
926961df833SKyungmin Park vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
927961df833SKyungmin Park if (!vid_hdr)
928961df833SKyungmin Park return -ENOMEM;
929961df833SKyungmin Park
930961df833SKyungmin Park mutex_lock(&ubi->alc_mutex);
931961df833SKyungmin Park err = leb_write_lock(ubi, vol_id, lnum);
932961df833SKyungmin Park if (err)
933961df833SKyungmin Park goto out_mutex;
934961df833SKyungmin Park
935ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
936961df833SKyungmin Park vid_hdr->vol_id = cpu_to_be32(vol_id);
937961df833SKyungmin Park vid_hdr->lnum = cpu_to_be32(lnum);
938961df833SKyungmin Park vid_hdr->compat = ubi_get_compat(ubi, vol_id);
939961df833SKyungmin Park vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
940961df833SKyungmin Park
941961df833SKyungmin Park crc = crc32(UBI_CRC32_INIT, buf, len);
942961df833SKyungmin Park vid_hdr->vol_type = UBI_VID_DYNAMIC;
943961df833SKyungmin Park vid_hdr->data_size = cpu_to_be32(len);
944961df833SKyungmin Park vid_hdr->copy_flag = 1;
945961df833SKyungmin Park vid_hdr->data_crc = cpu_to_be32(crc);
946961df833SKyungmin Park
947961df833SKyungmin Park retry:
948ff94bc40SHeiko Schocher pnum = ubi_wl_get_peb(ubi);
949961df833SKyungmin Park if (pnum < 0) {
950961df833SKyungmin Park err = pnum;
951*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
952961df833SKyungmin Park goto out_leb_unlock;
953961df833SKyungmin Park }
954961df833SKyungmin Park
955961df833SKyungmin Park dbg_eba("change LEB %d:%d, PEB %d, write VID hdr to PEB %d",
956961df833SKyungmin Park vol_id, lnum, vol->eba_tbl[lnum], pnum);
957961df833SKyungmin Park
958961df833SKyungmin Park err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
959961df833SKyungmin Park if (err) {
960*0195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
961961df833SKyungmin Park vol_id, lnum, pnum);
962*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
963961df833SKyungmin Park goto write_error;
964961df833SKyungmin Park }
965961df833SKyungmin Park
966961df833SKyungmin Park err = ubi_io_write_data(ubi, buf, pnum, 0, len);
967961df833SKyungmin Park if (err) {
968*0195a7bbSHeiko Schocher ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
969961df833SKyungmin Park len, pnum);
970*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
971961df833SKyungmin Park goto write_error;
972961df833SKyungmin Park }
973961df833SKyungmin Park
974*0195a7bbSHeiko Schocher old_pnum = vol->eba_tbl[lnum];
975*0195a7bbSHeiko Schocher vol->eba_tbl[lnum] = pnum;
976*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
977*0195a7bbSHeiko Schocher
978*0195a7bbSHeiko Schocher if (old_pnum >= 0) {
979*0195a7bbSHeiko Schocher err = ubi_wl_put_peb(ubi, vol_id, lnum, old_pnum, 0);
980961df833SKyungmin Park if (err)
981961df833SKyungmin Park goto out_leb_unlock;
982961df833SKyungmin Park }
983961df833SKyungmin Park
984961df833SKyungmin Park out_leb_unlock:
985961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
986961df833SKyungmin Park out_mutex:
987961df833SKyungmin Park mutex_unlock(&ubi->alc_mutex);
988961df833SKyungmin Park ubi_free_vid_hdr(ubi, vid_hdr);
989961df833SKyungmin Park return err;
990961df833SKyungmin Park
991961df833SKyungmin Park write_error:
992961df833SKyungmin Park if (err != -EIO || !ubi->bad_allowed) {
993961df833SKyungmin Park /*
994961df833SKyungmin Park * This flash device does not admit of bad eraseblocks or
995961df833SKyungmin Park * something nasty and unexpected happened. Switch to read-only
996961df833SKyungmin Park * mode just in case.
997961df833SKyungmin Park */
998961df833SKyungmin Park ubi_ro_mode(ubi);
999961df833SKyungmin Park goto out_leb_unlock;
1000961df833SKyungmin Park }
1001961df833SKyungmin Park
1002ff94bc40SHeiko Schocher err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
1003961df833SKyungmin Park if (err || ++tries > UBI_IO_RETRIES) {
1004961df833SKyungmin Park ubi_ro_mode(ubi);
1005961df833SKyungmin Park goto out_leb_unlock;
1006961df833SKyungmin Park }
1007961df833SKyungmin Park
1008ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1009*0195a7bbSHeiko Schocher ubi_msg(ubi, "try another PEB");
1010961df833SKyungmin Park goto retry;
1011961df833SKyungmin Park }
1012961df833SKyungmin Park
1013961df833SKyungmin Park /**
1014ff94bc40SHeiko Schocher * is_error_sane - check whether a read error is sane.
1015ff94bc40SHeiko Schocher * @err: code of the error happened during reading
1016ff94bc40SHeiko Schocher *
1017ff94bc40SHeiko Schocher * This is a helper function for 'ubi_eba_copy_leb()' which is called when we
1018ff94bc40SHeiko Schocher * cannot read data from the target PEB (an error @err happened). If the error
1019ff94bc40SHeiko Schocher * code is sane, then we treat this error as non-fatal. Otherwise the error is
1020ff94bc40SHeiko Schocher * fatal and UBI will be switched to R/O mode later.
1021ff94bc40SHeiko Schocher *
1022ff94bc40SHeiko Schocher * The idea is that we try not to switch to R/O mode if the read error is
1023ff94bc40SHeiko Schocher * something which suggests there was a real read problem. E.g., %-EIO. Or a
1024ff94bc40SHeiko Schocher * memory allocation failed (-%ENOMEM). Otherwise, it is safer to switch to R/O
1025ff94bc40SHeiko Schocher * mode, simply because we do not know what happened at the MTD level, and we
1026ff94bc40SHeiko Schocher * cannot handle this. E.g., the underlying driver may have become crazy, and
1027ff94bc40SHeiko Schocher * it is safer to switch to R/O mode to preserve the data.
1028ff94bc40SHeiko Schocher *
1029ff94bc40SHeiko Schocher * And bear in mind, this is about reading from the target PEB, i.e. the PEB
1030ff94bc40SHeiko Schocher * which we have just written.
1031ff94bc40SHeiko Schocher */
is_error_sane(int err)1032ff94bc40SHeiko Schocher static int is_error_sane(int err)
1033ff94bc40SHeiko Schocher {
1034ff94bc40SHeiko Schocher if (err == -EIO || err == -ENOMEM || err == UBI_IO_BAD_HDR ||
1035ff94bc40SHeiko Schocher err == UBI_IO_BAD_HDR_EBADMSG || err == -ETIMEDOUT)
1036ff94bc40SHeiko Schocher return 0;
1037ff94bc40SHeiko Schocher return 1;
1038ff94bc40SHeiko Schocher }
1039ff94bc40SHeiko Schocher
1040ff94bc40SHeiko Schocher /**
1041961df833SKyungmin Park * ubi_eba_copy_leb - copy logical eraseblock.
1042961df833SKyungmin Park * @ubi: UBI device description object
1043961df833SKyungmin Park * @from: physical eraseblock number from where to copy
1044961df833SKyungmin Park * @to: physical eraseblock number where to copy
1045961df833SKyungmin Park * @vid_hdr: VID header of the @from physical eraseblock
1046961df833SKyungmin Park *
1047961df833SKyungmin Park * This function copies logical eraseblock from physical eraseblock @from to
1048961df833SKyungmin Park * physical eraseblock @to. The @vid_hdr buffer may be changed by this
1049961df833SKyungmin Park * function. Returns:
1050961df833SKyungmin Park * o %0 in case of success;
1051ff94bc40SHeiko Schocher * o %MOVE_CANCEL_RACE, %MOVE_TARGET_WR_ERR, %MOVE_TARGET_BITFLIPS, etc;
1052ff94bc40SHeiko Schocher * o a negative error code in case of failure.
1053961df833SKyungmin Park */
ubi_eba_copy_leb(struct ubi_device * ubi,int from,int to,struct ubi_vid_hdr * vid_hdr)1054961df833SKyungmin Park int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
1055961df833SKyungmin Park struct ubi_vid_hdr *vid_hdr)
1056961df833SKyungmin Park {
1057961df833SKyungmin Park int err, vol_id, lnum, data_size, aldata_size, idx;
1058961df833SKyungmin Park struct ubi_volume *vol;
1059961df833SKyungmin Park uint32_t crc;
1060961df833SKyungmin Park
1061961df833SKyungmin Park vol_id = be32_to_cpu(vid_hdr->vol_id);
1062961df833SKyungmin Park lnum = be32_to_cpu(vid_hdr->lnum);
1063961df833SKyungmin Park
1064ff94bc40SHeiko Schocher dbg_wl("copy LEB %d:%d, PEB %d to PEB %d", vol_id, lnum, from, to);
1065961df833SKyungmin Park
1066961df833SKyungmin Park if (vid_hdr->vol_type == UBI_VID_STATIC) {
1067961df833SKyungmin Park data_size = be32_to_cpu(vid_hdr->data_size);
1068961df833SKyungmin Park aldata_size = ALIGN(data_size, ubi->min_io_size);
1069961df833SKyungmin Park } else
1070961df833SKyungmin Park data_size = aldata_size =
1071961df833SKyungmin Park ubi->leb_size - be32_to_cpu(vid_hdr->data_pad);
1072961df833SKyungmin Park
1073961df833SKyungmin Park idx = vol_id2idx(ubi, vol_id);
1074961df833SKyungmin Park spin_lock(&ubi->volumes_lock);
1075961df833SKyungmin Park /*
1076961df833SKyungmin Park * Note, we may race with volume deletion, which means that the volume
1077961df833SKyungmin Park * this logical eraseblock belongs to might be being deleted. Since the
1078ff94bc40SHeiko Schocher * volume deletion un-maps all the volume's logical eraseblocks, it will
1079961df833SKyungmin Park * be locked in 'ubi_wl_put_peb()' and wait for the WL worker to finish.
1080961df833SKyungmin Park */
1081961df833SKyungmin Park vol = ubi->volumes[idx];
1082ff94bc40SHeiko Schocher spin_unlock(&ubi->volumes_lock);
1083961df833SKyungmin Park if (!vol) {
1084961df833SKyungmin Park /* No need to do further work, cancel */
1085ff94bc40SHeiko Schocher dbg_wl("volume %d is being removed, cancel", vol_id);
1086ff94bc40SHeiko Schocher return MOVE_CANCEL_RACE;
1087961df833SKyungmin Park }
1088961df833SKyungmin Park
1089961df833SKyungmin Park /*
1090961df833SKyungmin Park * We do not want anybody to write to this logical eraseblock while we
1091961df833SKyungmin Park * are moving it, so lock it.
1092961df833SKyungmin Park *
1093961df833SKyungmin Park * Note, we are using non-waiting locking here, because we cannot sleep
1094961df833SKyungmin Park * on the LEB, since it may cause deadlocks. Indeed, imagine a task is
1095961df833SKyungmin Park * unmapping the LEB which is mapped to the PEB we are going to move
1096961df833SKyungmin Park * (@from). This task locks the LEB and goes sleep in the
1097961df833SKyungmin Park * 'ubi_wl_put_peb()' function on the @ubi->move_mutex. In turn, we are
1098961df833SKyungmin Park * holding @ubi->move_mutex and go sleep on the LEB lock. So, if the
1099ff94bc40SHeiko Schocher * LEB is already locked, we just do not move it and return
1100ff94bc40SHeiko Schocher * %MOVE_RETRY. Note, we do not return %MOVE_CANCEL_RACE here because
1101ff94bc40SHeiko Schocher * we do not know the reasons of the contention - it may be just a
1102ff94bc40SHeiko Schocher * normal I/O on this LEB, so we want to re-try.
1103961df833SKyungmin Park */
1104961df833SKyungmin Park err = leb_write_trylock(ubi, vol_id, lnum);
1105961df833SKyungmin Park if (err) {
1106ff94bc40SHeiko Schocher dbg_wl("contention on LEB %d:%d, cancel", vol_id, lnum);
1107ff94bc40SHeiko Schocher return MOVE_RETRY;
1108961df833SKyungmin Park }
1109961df833SKyungmin Park
1110961df833SKyungmin Park /*
1111961df833SKyungmin Park * The LEB might have been put meanwhile, and the task which put it is
1112961df833SKyungmin Park * probably waiting on @ubi->move_mutex. No need to continue the work,
1113961df833SKyungmin Park * cancel it.
1114961df833SKyungmin Park */
1115961df833SKyungmin Park if (vol->eba_tbl[lnum] != from) {
1116ff94bc40SHeiko Schocher dbg_wl("LEB %d:%d is no longer mapped to PEB %d, mapped to PEB %d, cancel",
1117ff94bc40SHeiko Schocher vol_id, lnum, from, vol->eba_tbl[lnum]);
1118ff94bc40SHeiko Schocher err = MOVE_CANCEL_RACE;
1119961df833SKyungmin Park goto out_unlock_leb;
1120961df833SKyungmin Park }
1121961df833SKyungmin Park
1122961df833SKyungmin Park /*
1123ff94bc40SHeiko Schocher * OK, now the LEB is locked and we can safely start moving it. Since
1124ff94bc40SHeiko Schocher * this function utilizes the @ubi->peb_buf buffer which is shared
1125ff94bc40SHeiko Schocher * with some other functions - we lock the buffer by taking the
1126961df833SKyungmin Park * @ubi->buf_mutex.
1127961df833SKyungmin Park */
1128961df833SKyungmin Park mutex_lock(&ubi->buf_mutex);
1129ff94bc40SHeiko Schocher dbg_wl("read %d bytes of data", aldata_size);
1130ff94bc40SHeiko Schocher err = ubi_io_read_data(ubi, ubi->peb_buf, from, 0, aldata_size);
1131961df833SKyungmin Park if (err && err != UBI_IO_BITFLIPS) {
1132*0195a7bbSHeiko Schocher ubi_warn(ubi, "error %d while reading data from PEB %d",
1133961df833SKyungmin Park err, from);
1134ff94bc40SHeiko Schocher err = MOVE_SOURCE_RD_ERR;
1135961df833SKyungmin Park goto out_unlock_buf;
1136961df833SKyungmin Park }
1137961df833SKyungmin Park
1138961df833SKyungmin Park /*
1139ff94bc40SHeiko Schocher * Now we have got to calculate how much data we have to copy. In
1140961df833SKyungmin Park * case of a static volume it is fairly easy - the VID header contains
1141961df833SKyungmin Park * the data size. In case of a dynamic volume it is more difficult - we
1142961df833SKyungmin Park * have to read the contents, cut 0xFF bytes from the end and copy only
1143961df833SKyungmin Park * the first part. We must do this to avoid writing 0xFF bytes as it
1144961df833SKyungmin Park * may have some side-effects. And not only this. It is important not
1145961df833SKyungmin Park * to include those 0xFFs to CRC because later the they may be filled
1146961df833SKyungmin Park * by data.
1147961df833SKyungmin Park */
1148961df833SKyungmin Park if (vid_hdr->vol_type == UBI_VID_DYNAMIC)
1149961df833SKyungmin Park aldata_size = data_size =
1150ff94bc40SHeiko Schocher ubi_calc_data_len(ubi, ubi->peb_buf, data_size);
1151961df833SKyungmin Park
1152961df833SKyungmin Park cond_resched();
1153ff94bc40SHeiko Schocher crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
1154961df833SKyungmin Park cond_resched();
1155961df833SKyungmin Park
1156961df833SKyungmin Park /*
1157ff94bc40SHeiko Schocher * It may turn out to be that the whole @from physical eraseblock
1158961df833SKyungmin Park * contains only 0xFF bytes. Then we have to only write the VID header
1159961df833SKyungmin Park * and do not write any data. This also means we should not set
1160961df833SKyungmin Park * @vid_hdr->copy_flag, @vid_hdr->data_size, and @vid_hdr->data_crc.
1161961df833SKyungmin Park */
1162961df833SKyungmin Park if (data_size > 0) {
1163961df833SKyungmin Park vid_hdr->copy_flag = 1;
1164961df833SKyungmin Park vid_hdr->data_size = cpu_to_be32(data_size);
1165961df833SKyungmin Park vid_hdr->data_crc = cpu_to_be32(crc);
1166961df833SKyungmin Park }
1167ff94bc40SHeiko Schocher vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1168961df833SKyungmin Park
1169961df833SKyungmin Park err = ubi_io_write_vid_hdr(ubi, to, vid_hdr);
1170ff94bc40SHeiko Schocher if (err) {
1171ff94bc40SHeiko Schocher if (err == -EIO)
1172ff94bc40SHeiko Schocher err = MOVE_TARGET_WR_ERR;
1173961df833SKyungmin Park goto out_unlock_buf;
1174ff94bc40SHeiko Schocher }
1175961df833SKyungmin Park
1176961df833SKyungmin Park cond_resched();
1177961df833SKyungmin Park
1178961df833SKyungmin Park /* Read the VID header back and check if it was written correctly */
1179961df833SKyungmin Park err = ubi_io_read_vid_hdr(ubi, to, vid_hdr, 1);
1180961df833SKyungmin Park if (err) {
1181ff94bc40SHeiko Schocher if (err != UBI_IO_BITFLIPS) {
1182*0195a7bbSHeiko Schocher ubi_warn(ubi, "error %d while reading VID header back from PEB %d",
1183ff94bc40SHeiko Schocher err, to);
1184ff94bc40SHeiko Schocher if (is_error_sane(err))
1185ff94bc40SHeiko Schocher err = MOVE_TARGET_RD_ERR;
1186ff94bc40SHeiko Schocher } else
1187ff94bc40SHeiko Schocher err = MOVE_TARGET_BITFLIPS;
1188961df833SKyungmin Park goto out_unlock_buf;
1189961df833SKyungmin Park }
1190961df833SKyungmin Park
1191961df833SKyungmin Park if (data_size > 0) {
1192ff94bc40SHeiko Schocher err = ubi_io_write_data(ubi, ubi->peb_buf, to, 0, aldata_size);
1193ff94bc40SHeiko Schocher if (err) {
1194ff94bc40SHeiko Schocher if (err == -EIO)
1195ff94bc40SHeiko Schocher err = MOVE_TARGET_WR_ERR;
1196961df833SKyungmin Park goto out_unlock_buf;
1197ff94bc40SHeiko Schocher }
1198961df833SKyungmin Park
1199961df833SKyungmin Park cond_resched();
1200961df833SKyungmin Park
1201961df833SKyungmin Park /*
1202961df833SKyungmin Park * We've written the data and are going to read it back to make
1203961df833SKyungmin Park * sure it was written correctly.
1204961df833SKyungmin Park */
1205ff94bc40SHeiko Schocher memset(ubi->peb_buf, 0xFF, aldata_size);
1206ff94bc40SHeiko Schocher err = ubi_io_read_data(ubi, ubi->peb_buf, to, 0, aldata_size);
1207961df833SKyungmin Park if (err) {
1208ff94bc40SHeiko Schocher if (err != UBI_IO_BITFLIPS) {
1209*0195a7bbSHeiko Schocher ubi_warn(ubi, "error %d while reading data back from PEB %d",
1210ff94bc40SHeiko Schocher err, to);
1211ff94bc40SHeiko Schocher if (is_error_sane(err))
1212ff94bc40SHeiko Schocher err = MOVE_TARGET_RD_ERR;
1213ff94bc40SHeiko Schocher } else
1214ff94bc40SHeiko Schocher err = MOVE_TARGET_BITFLIPS;
1215961df833SKyungmin Park goto out_unlock_buf;
1216961df833SKyungmin Park }
1217961df833SKyungmin Park
1218961df833SKyungmin Park cond_resched();
1219961df833SKyungmin Park
1220ff94bc40SHeiko Schocher if (crc != crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size)) {
1221*0195a7bbSHeiko Schocher ubi_warn(ubi, "read data back from PEB %d and it is different",
1222961df833SKyungmin Park to);
1223ff94bc40SHeiko Schocher err = -EINVAL;
1224961df833SKyungmin Park goto out_unlock_buf;
1225961df833SKyungmin Park }
1226961df833SKyungmin Park }
1227961df833SKyungmin Park
1228961df833SKyungmin Park ubi_assert(vol->eba_tbl[lnum] == from);
1229*0195a7bbSHeiko Schocher down_read(&ubi->fm_eba_sem);
1230961df833SKyungmin Park vol->eba_tbl[lnum] = to;
1231*0195a7bbSHeiko Schocher up_read(&ubi->fm_eba_sem);
1232961df833SKyungmin Park
1233961df833SKyungmin Park out_unlock_buf:
1234961df833SKyungmin Park mutex_unlock(&ubi->buf_mutex);
1235961df833SKyungmin Park out_unlock_leb:
1236961df833SKyungmin Park leb_write_unlock(ubi, vol_id, lnum);
1237961df833SKyungmin Park return err;
1238961df833SKyungmin Park }
1239961df833SKyungmin Park
1240961df833SKyungmin Park /**
1241ff94bc40SHeiko Schocher * print_rsvd_warning - warn about not having enough reserved PEBs.
1242961df833SKyungmin Park * @ubi: UBI device description object
1243ff94bc40SHeiko Schocher *
1244ff94bc40SHeiko Schocher * This is a helper function for 'ubi_eba_init()' which is called when UBI
1245ff94bc40SHeiko Schocher * cannot reserve enough PEBs for bad block handling. This function makes a
1246ff94bc40SHeiko Schocher * decision whether we have to print a warning or not. The algorithm is as
1247ff94bc40SHeiko Schocher * follows:
1248ff94bc40SHeiko Schocher * o if this is a new UBI image, then just print the warning
1249ff94bc40SHeiko Schocher * o if this is an UBI image which has already been used for some time, print
1250ff94bc40SHeiko Schocher * a warning only if we can reserve less than 10% of the expected amount of
1251ff94bc40SHeiko Schocher * the reserved PEB.
1252ff94bc40SHeiko Schocher *
1253ff94bc40SHeiko Schocher * The idea is that when UBI is used, PEBs become bad, and the reserved pool
1254ff94bc40SHeiko Schocher * of PEBs becomes smaller, which is normal and we do not want to scare users
1255ff94bc40SHeiko Schocher * with a warning every time they attach the MTD device. This was an issue
1256ff94bc40SHeiko Schocher * reported by real users.
1257ff94bc40SHeiko Schocher */
print_rsvd_warning(struct ubi_device * ubi,struct ubi_attach_info * ai)1258ff94bc40SHeiko Schocher static void print_rsvd_warning(struct ubi_device *ubi,
1259ff94bc40SHeiko Schocher struct ubi_attach_info *ai)
1260ff94bc40SHeiko Schocher {
1261ff94bc40SHeiko Schocher /*
1262ff94bc40SHeiko Schocher * The 1 << 18 (256KiB) number is picked randomly, just a reasonably
1263ff94bc40SHeiko Schocher * large number to distinguish between newly flashed and used images.
1264ff94bc40SHeiko Schocher */
1265ff94bc40SHeiko Schocher if (ai->max_sqnum > (1 << 18)) {
1266ff94bc40SHeiko Schocher int min = ubi->beb_rsvd_level / 10;
1267ff94bc40SHeiko Schocher
1268ff94bc40SHeiko Schocher if (!min)
1269ff94bc40SHeiko Schocher min = 1;
1270ff94bc40SHeiko Schocher if (ubi->beb_rsvd_pebs > min)
1271ff94bc40SHeiko Schocher return;
1272ff94bc40SHeiko Schocher }
1273ff94bc40SHeiko Schocher
1274*0195a7bbSHeiko Schocher ubi_warn(ubi, "cannot reserve enough PEBs for bad PEB handling, reserved %d, need %d",
1275ff94bc40SHeiko Schocher ubi->beb_rsvd_pebs, ubi->beb_rsvd_level);
1276ff94bc40SHeiko Schocher if (ubi->corr_peb_count)
1277*0195a7bbSHeiko Schocher ubi_warn(ubi, "%d PEBs are corrupted and not used",
1278ff94bc40SHeiko Schocher ubi->corr_peb_count);
1279ff94bc40SHeiko Schocher }
1280ff94bc40SHeiko Schocher
1281ff94bc40SHeiko Schocher /**
1282ff94bc40SHeiko Schocher * self_check_eba - run a self check on the EBA table constructed by fastmap.
1283ff94bc40SHeiko Schocher * @ubi: UBI device description object
1284ff94bc40SHeiko Schocher * @ai_fastmap: UBI attach info object created by fastmap
1285ff94bc40SHeiko Schocher * @ai_scan: UBI attach info object created by scanning
1286ff94bc40SHeiko Schocher *
1287ff94bc40SHeiko Schocher * Returns < 0 in case of an internal error, 0 otherwise.
1288ff94bc40SHeiko Schocher * If a bad EBA table entry was found it will be printed out and
1289ff94bc40SHeiko Schocher * ubi_assert() triggers.
1290ff94bc40SHeiko Schocher */
self_check_eba(struct ubi_device * ubi,struct ubi_attach_info * ai_fastmap,struct ubi_attach_info * ai_scan)1291ff94bc40SHeiko Schocher int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
1292ff94bc40SHeiko Schocher struct ubi_attach_info *ai_scan)
1293ff94bc40SHeiko Schocher {
1294ff94bc40SHeiko Schocher int i, j, num_volumes, ret = 0;
1295ff94bc40SHeiko Schocher int **scan_eba, **fm_eba;
1296ff94bc40SHeiko Schocher struct ubi_ainf_volume *av;
1297ff94bc40SHeiko Schocher struct ubi_volume *vol;
1298ff94bc40SHeiko Schocher struct ubi_ainf_peb *aeb;
1299ff94bc40SHeiko Schocher struct rb_node *rb;
1300ff94bc40SHeiko Schocher
1301ff94bc40SHeiko Schocher num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1302ff94bc40SHeiko Schocher
1303ff94bc40SHeiko Schocher scan_eba = kmalloc(sizeof(*scan_eba) * num_volumes, GFP_KERNEL);
1304ff94bc40SHeiko Schocher if (!scan_eba)
1305ff94bc40SHeiko Schocher return -ENOMEM;
1306ff94bc40SHeiko Schocher
1307ff94bc40SHeiko Schocher fm_eba = kmalloc(sizeof(*fm_eba) * num_volumes, GFP_KERNEL);
1308ff94bc40SHeiko Schocher if (!fm_eba) {
1309ff94bc40SHeiko Schocher kfree(scan_eba);
1310ff94bc40SHeiko Schocher return -ENOMEM;
1311ff94bc40SHeiko Schocher }
1312ff94bc40SHeiko Schocher
1313ff94bc40SHeiko Schocher for (i = 0; i < num_volumes; i++) {
1314ff94bc40SHeiko Schocher vol = ubi->volumes[i];
1315ff94bc40SHeiko Schocher if (!vol)
1316ff94bc40SHeiko Schocher continue;
1317ff94bc40SHeiko Schocher
1318ff94bc40SHeiko Schocher scan_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**scan_eba),
1319ff94bc40SHeiko Schocher GFP_KERNEL);
1320ff94bc40SHeiko Schocher if (!scan_eba[i]) {
1321ff94bc40SHeiko Schocher ret = -ENOMEM;
1322ff94bc40SHeiko Schocher goto out_free;
1323ff94bc40SHeiko Schocher }
1324ff94bc40SHeiko Schocher
1325ff94bc40SHeiko Schocher fm_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**fm_eba),
1326ff94bc40SHeiko Schocher GFP_KERNEL);
1327ff94bc40SHeiko Schocher if (!fm_eba[i]) {
1328ff94bc40SHeiko Schocher ret = -ENOMEM;
1329ff94bc40SHeiko Schocher goto out_free;
1330ff94bc40SHeiko Schocher }
1331ff94bc40SHeiko Schocher
1332ff94bc40SHeiko Schocher for (j = 0; j < vol->reserved_pebs; j++)
1333ff94bc40SHeiko Schocher scan_eba[i][j] = fm_eba[i][j] = UBI_LEB_UNMAPPED;
1334ff94bc40SHeiko Schocher
1335ff94bc40SHeiko Schocher av = ubi_find_av(ai_scan, idx2vol_id(ubi, i));
1336ff94bc40SHeiko Schocher if (!av)
1337ff94bc40SHeiko Schocher continue;
1338ff94bc40SHeiko Schocher
1339ff94bc40SHeiko Schocher ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1340ff94bc40SHeiko Schocher scan_eba[i][aeb->lnum] = aeb->pnum;
1341ff94bc40SHeiko Schocher
1342ff94bc40SHeiko Schocher av = ubi_find_av(ai_fastmap, idx2vol_id(ubi, i));
1343ff94bc40SHeiko Schocher if (!av)
1344ff94bc40SHeiko Schocher continue;
1345ff94bc40SHeiko Schocher
1346ff94bc40SHeiko Schocher ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1347ff94bc40SHeiko Schocher fm_eba[i][aeb->lnum] = aeb->pnum;
1348ff94bc40SHeiko Schocher
1349ff94bc40SHeiko Schocher for (j = 0; j < vol->reserved_pebs; j++) {
1350ff94bc40SHeiko Schocher if (scan_eba[i][j] != fm_eba[i][j]) {
1351ff94bc40SHeiko Schocher if (scan_eba[i][j] == UBI_LEB_UNMAPPED ||
1352ff94bc40SHeiko Schocher fm_eba[i][j] == UBI_LEB_UNMAPPED)
1353ff94bc40SHeiko Schocher continue;
1354ff94bc40SHeiko Schocher
1355*0195a7bbSHeiko Schocher ubi_err(ubi, "LEB:%i:%i is PEB:%i instead of %i!",
1356ff94bc40SHeiko Schocher vol->vol_id, i, fm_eba[i][j],
1357ff94bc40SHeiko Schocher scan_eba[i][j]);
1358ff94bc40SHeiko Schocher ubi_assert(0);
1359ff94bc40SHeiko Schocher }
1360ff94bc40SHeiko Schocher }
1361ff94bc40SHeiko Schocher }
1362ff94bc40SHeiko Schocher
1363ff94bc40SHeiko Schocher out_free:
1364ff94bc40SHeiko Schocher for (i = 0; i < num_volumes; i++) {
1365ff94bc40SHeiko Schocher if (!ubi->volumes[i])
1366ff94bc40SHeiko Schocher continue;
1367ff94bc40SHeiko Schocher
1368ff94bc40SHeiko Schocher kfree(scan_eba[i]);
1369ff94bc40SHeiko Schocher kfree(fm_eba[i]);
1370ff94bc40SHeiko Schocher }
1371ff94bc40SHeiko Schocher
1372ff94bc40SHeiko Schocher kfree(scan_eba);
1373ff94bc40SHeiko Schocher kfree(fm_eba);
1374ff94bc40SHeiko Schocher return ret;
1375ff94bc40SHeiko Schocher }
1376ff94bc40SHeiko Schocher
1377ff94bc40SHeiko Schocher /**
1378ff94bc40SHeiko Schocher * ubi_eba_init - initialize the EBA sub-system using attaching information.
1379ff94bc40SHeiko Schocher * @ubi: UBI device description object
1380ff94bc40SHeiko Schocher * @ai: attaching information
1381961df833SKyungmin Park *
1382961df833SKyungmin Park * This function returns zero in case of success and a negative error code in
1383961df833SKyungmin Park * case of failure.
1384961df833SKyungmin Park */
ubi_eba_init(struct ubi_device * ubi,struct ubi_attach_info * ai)1385ff94bc40SHeiko Schocher int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
1386961df833SKyungmin Park {
1387961df833SKyungmin Park int i, j, err, num_volumes;
1388ff94bc40SHeiko Schocher struct ubi_ainf_volume *av;
1389961df833SKyungmin Park struct ubi_volume *vol;
1390ff94bc40SHeiko Schocher struct ubi_ainf_peb *aeb;
1391961df833SKyungmin Park struct rb_node *rb;
1392961df833SKyungmin Park
1393ff94bc40SHeiko Schocher dbg_eba("initialize EBA sub-system");
1394961df833SKyungmin Park
1395961df833SKyungmin Park spin_lock_init(&ubi->ltree_lock);
1396961df833SKyungmin Park mutex_init(&ubi->alc_mutex);
1397961df833SKyungmin Park ubi->ltree = RB_ROOT;
1398961df833SKyungmin Park
1399ff94bc40SHeiko Schocher ubi->global_sqnum = ai->max_sqnum + 1;
1400961df833SKyungmin Park num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1401961df833SKyungmin Park
1402961df833SKyungmin Park for (i = 0; i < num_volumes; i++) {
1403961df833SKyungmin Park vol = ubi->volumes[i];
1404961df833SKyungmin Park if (!vol)
1405961df833SKyungmin Park continue;
1406961df833SKyungmin Park
1407961df833SKyungmin Park cond_resched();
1408961df833SKyungmin Park
1409961df833SKyungmin Park vol->eba_tbl = kmalloc(vol->reserved_pebs * sizeof(int),
1410961df833SKyungmin Park GFP_KERNEL);
1411961df833SKyungmin Park if (!vol->eba_tbl) {
1412961df833SKyungmin Park err = -ENOMEM;
1413961df833SKyungmin Park goto out_free;
1414961df833SKyungmin Park }
1415961df833SKyungmin Park
1416961df833SKyungmin Park for (j = 0; j < vol->reserved_pebs; j++)
1417961df833SKyungmin Park vol->eba_tbl[j] = UBI_LEB_UNMAPPED;
1418961df833SKyungmin Park
1419ff94bc40SHeiko Schocher av = ubi_find_av(ai, idx2vol_id(ubi, i));
1420ff94bc40SHeiko Schocher if (!av)
1421961df833SKyungmin Park continue;
1422961df833SKyungmin Park
1423ff94bc40SHeiko Schocher ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
1424ff94bc40SHeiko Schocher if (aeb->lnum >= vol->reserved_pebs)
1425961df833SKyungmin Park /*
1426961df833SKyungmin Park * This may happen in case of an unclean reboot
1427961df833SKyungmin Park * during re-size.
1428961df833SKyungmin Park */
1429ff94bc40SHeiko Schocher ubi_move_aeb_to_list(av, aeb, &ai->erase);
1430*0195a7bbSHeiko Schocher else
1431ff94bc40SHeiko Schocher vol->eba_tbl[aeb->lnum] = aeb->pnum;
1432961df833SKyungmin Park }
1433961df833SKyungmin Park }
1434961df833SKyungmin Park
1435961df833SKyungmin Park if (ubi->avail_pebs < EBA_RESERVED_PEBS) {
1436*0195a7bbSHeiko Schocher ubi_err(ubi, "no enough physical eraseblocks (%d, need %d)",
1437961df833SKyungmin Park ubi->avail_pebs, EBA_RESERVED_PEBS);
1438ff94bc40SHeiko Schocher if (ubi->corr_peb_count)
1439*0195a7bbSHeiko Schocher ubi_err(ubi, "%d PEBs are corrupted and not used",
1440ff94bc40SHeiko Schocher ubi->corr_peb_count);
1441961df833SKyungmin Park err = -ENOSPC;
1442961df833SKyungmin Park goto out_free;
1443961df833SKyungmin Park }
1444961df833SKyungmin Park ubi->avail_pebs -= EBA_RESERVED_PEBS;
1445961df833SKyungmin Park ubi->rsvd_pebs += EBA_RESERVED_PEBS;
1446961df833SKyungmin Park
1447961df833SKyungmin Park if (ubi->bad_allowed) {
1448961df833SKyungmin Park ubi_calculate_reserved(ubi);
1449961df833SKyungmin Park
1450961df833SKyungmin Park if (ubi->avail_pebs < ubi->beb_rsvd_level) {
1451961df833SKyungmin Park /* No enough free physical eraseblocks */
1452961df833SKyungmin Park ubi->beb_rsvd_pebs = ubi->avail_pebs;
1453ff94bc40SHeiko Schocher print_rsvd_warning(ubi, ai);
1454961df833SKyungmin Park } else
1455961df833SKyungmin Park ubi->beb_rsvd_pebs = ubi->beb_rsvd_level;
1456961df833SKyungmin Park
1457961df833SKyungmin Park ubi->avail_pebs -= ubi->beb_rsvd_pebs;
1458961df833SKyungmin Park ubi->rsvd_pebs += ubi->beb_rsvd_pebs;
1459961df833SKyungmin Park }
1460961df833SKyungmin Park
1461ff94bc40SHeiko Schocher dbg_eba("EBA sub-system is initialized");
1462961df833SKyungmin Park return 0;
1463961df833SKyungmin Park
1464961df833SKyungmin Park out_free:
1465961df833SKyungmin Park for (i = 0; i < num_volumes; i++) {
1466961df833SKyungmin Park if (!ubi->volumes[i])
1467961df833SKyungmin Park continue;
1468961df833SKyungmin Park kfree(ubi->volumes[i]->eba_tbl);
1469ff94bc40SHeiko Schocher ubi->volumes[i]->eba_tbl = NULL;
1470961df833SKyungmin Park }
1471961df833SKyungmin Park return err;
1472961df833SKyungmin Park }
1473