xref: /OK3568_Linux_fs/u-boot/drivers/mtd/ubi/eba.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (c) International Business Machines Corp., 2006
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * SPDX-License-Identifier:	GPL-2.0+
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Author: Artem Bityutskiy (Битюцкий Артём)
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun /*
10*4882a593Smuzhiyun  * The UBI Eraseblock Association (EBA) sub-system.
11*4882a593Smuzhiyun  *
12*4882a593Smuzhiyun  * This sub-system is responsible for I/O to/from logical eraseblock.
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  * Although in this implementation the EBA table is fully kept and managed in
15*4882a593Smuzhiyun  * RAM, which assumes poor scalability, it might be (partially) maintained on
16*4882a593Smuzhiyun  * flash in future implementations.
17*4882a593Smuzhiyun  *
18*4882a593Smuzhiyun  * The EBA sub-system implements per-logical eraseblock locking. Before
19*4882a593Smuzhiyun  * accessing a logical eraseblock it is locked for reading or writing. The
20*4882a593Smuzhiyun  * per-logical eraseblock locking is implemented by means of the lock tree. The
21*4882a593Smuzhiyun  * lock tree is an RB-tree which refers all the currently locked logical
22*4882a593Smuzhiyun  * eraseblocks. The lock tree elements are &struct ubi_ltree_entry objects.
23*4882a593Smuzhiyun  * They are indexed by (@vol_id, @lnum) pairs.
24*4882a593Smuzhiyun  *
25*4882a593Smuzhiyun  * EBA also maintains the global sequence counter which is incremented each
26*4882a593Smuzhiyun  * time a logical eraseblock is mapped to a physical eraseblock and it is
27*4882a593Smuzhiyun  * stored in the volume identifier header. This means that each VID header has
28*4882a593Smuzhiyun  * a unique sequence number. The sequence number is only increased an we assume
29*4882a593Smuzhiyun  * 64 bits is enough to never overflow.
30*4882a593Smuzhiyun  */
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun #ifndef __UBOOT__
33*4882a593Smuzhiyun #include <linux/slab.h>
34*4882a593Smuzhiyun #include <linux/crc32.h>
35*4882a593Smuzhiyun #else
36*4882a593Smuzhiyun #include <ubi_uboot.h>
37*4882a593Smuzhiyun #endif
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun #include <linux/err.h>
40*4882a593Smuzhiyun #include "ubi.h"
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun /* Number of physical eraseblocks reserved for atomic LEB change operation */
43*4882a593Smuzhiyun #define EBA_RESERVED_PEBS 1
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun /**
46*4882a593Smuzhiyun  * next_sqnum - get next sequence number.
47*4882a593Smuzhiyun  * @ubi: UBI device description object
48*4882a593Smuzhiyun  *
49*4882a593Smuzhiyun  * This function returns next sequence number to use, which is just the current
50*4882a593Smuzhiyun  * global sequence counter value. It also increases the global sequence
51*4882a593Smuzhiyun  * counter.
52*4882a593Smuzhiyun  */
ubi_next_sqnum(struct ubi_device * ubi)53*4882a593Smuzhiyun unsigned long long ubi_next_sqnum(struct ubi_device *ubi)
54*4882a593Smuzhiyun {
55*4882a593Smuzhiyun 	unsigned long long sqnum;
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 	spin_lock(&ubi->ltree_lock);
58*4882a593Smuzhiyun 	sqnum = ubi->global_sqnum++;
59*4882a593Smuzhiyun 	spin_unlock(&ubi->ltree_lock);
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun 	return sqnum;
62*4882a593Smuzhiyun }
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun /**
65*4882a593Smuzhiyun  * ubi_get_compat - get compatibility flags of a volume.
66*4882a593Smuzhiyun  * @ubi: UBI device description object
67*4882a593Smuzhiyun  * @vol_id: volume ID
68*4882a593Smuzhiyun  *
69*4882a593Smuzhiyun  * This function returns compatibility flags for an internal volume. User
70*4882a593Smuzhiyun  * volumes have no compatibility flags, so %0 is returned.
71*4882a593Smuzhiyun  */
ubi_get_compat(const struct ubi_device * ubi,int vol_id)72*4882a593Smuzhiyun static int ubi_get_compat(const struct ubi_device *ubi, int vol_id)
73*4882a593Smuzhiyun {
74*4882a593Smuzhiyun 	if (vol_id == UBI_LAYOUT_VOLUME_ID)
75*4882a593Smuzhiyun 		return UBI_LAYOUT_VOLUME_COMPAT;
76*4882a593Smuzhiyun 	return 0;
77*4882a593Smuzhiyun }
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun /**
80*4882a593Smuzhiyun  * ltree_lookup - look up the lock tree.
81*4882a593Smuzhiyun  * @ubi: UBI device description object
82*4882a593Smuzhiyun  * @vol_id: volume ID
83*4882a593Smuzhiyun  * @lnum: logical eraseblock number
84*4882a593Smuzhiyun  *
85*4882a593Smuzhiyun  * This function returns a pointer to the corresponding &struct ubi_ltree_entry
86*4882a593Smuzhiyun  * object if the logical eraseblock is locked and %NULL if it is not.
87*4882a593Smuzhiyun  * @ubi->ltree_lock has to be locked.
88*4882a593Smuzhiyun  */
ltree_lookup(struct ubi_device * ubi,int vol_id,int lnum)89*4882a593Smuzhiyun static struct ubi_ltree_entry *ltree_lookup(struct ubi_device *ubi, int vol_id,
90*4882a593Smuzhiyun 					    int lnum)
91*4882a593Smuzhiyun {
92*4882a593Smuzhiyun 	struct rb_node *p;
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 	p = ubi->ltree.rb_node;
95*4882a593Smuzhiyun 	while (p) {
96*4882a593Smuzhiyun 		struct ubi_ltree_entry *le;
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 		le = rb_entry(p, struct ubi_ltree_entry, rb);
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 		if (vol_id < le->vol_id)
101*4882a593Smuzhiyun 			p = p->rb_left;
102*4882a593Smuzhiyun 		else if (vol_id > le->vol_id)
103*4882a593Smuzhiyun 			p = p->rb_right;
104*4882a593Smuzhiyun 		else {
105*4882a593Smuzhiyun 			if (lnum < le->lnum)
106*4882a593Smuzhiyun 				p = p->rb_left;
107*4882a593Smuzhiyun 			else if (lnum > le->lnum)
108*4882a593Smuzhiyun 				p = p->rb_right;
109*4882a593Smuzhiyun 			else
110*4882a593Smuzhiyun 				return le;
111*4882a593Smuzhiyun 		}
112*4882a593Smuzhiyun 	}
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun 	return NULL;
115*4882a593Smuzhiyun }
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun /**
118*4882a593Smuzhiyun  * ltree_add_entry - add new entry to the lock tree.
119*4882a593Smuzhiyun  * @ubi: UBI device description object
120*4882a593Smuzhiyun  * @vol_id: volume ID
121*4882a593Smuzhiyun  * @lnum: logical eraseblock number
122*4882a593Smuzhiyun  *
123*4882a593Smuzhiyun  * This function adds new entry for logical eraseblock (@vol_id, @lnum) to the
124*4882a593Smuzhiyun  * lock tree. If such entry is already there, its usage counter is increased.
125*4882a593Smuzhiyun  * Returns pointer to the lock tree entry or %-ENOMEM if memory allocation
126*4882a593Smuzhiyun  * failed.
127*4882a593Smuzhiyun  */
ltree_add_entry(struct ubi_device * ubi,int vol_id,int lnum)128*4882a593Smuzhiyun static struct ubi_ltree_entry *ltree_add_entry(struct ubi_device *ubi,
129*4882a593Smuzhiyun 					       int vol_id, int lnum)
130*4882a593Smuzhiyun {
131*4882a593Smuzhiyun 	struct ubi_ltree_entry *le, *le1, *le_free;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	le = kmalloc(sizeof(struct ubi_ltree_entry), GFP_NOFS);
134*4882a593Smuzhiyun 	if (!le)
135*4882a593Smuzhiyun 		return ERR_PTR(-ENOMEM);
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun 	le->users = 0;
138*4882a593Smuzhiyun 	init_rwsem(&le->mutex);
139*4882a593Smuzhiyun 	le->vol_id = vol_id;
140*4882a593Smuzhiyun 	le->lnum = lnum;
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun 	spin_lock(&ubi->ltree_lock);
143*4882a593Smuzhiyun 	le1 = ltree_lookup(ubi, vol_id, lnum);
144*4882a593Smuzhiyun 
145*4882a593Smuzhiyun 	if (le1) {
146*4882a593Smuzhiyun 		/*
147*4882a593Smuzhiyun 		 * This logical eraseblock is already locked. The newly
148*4882a593Smuzhiyun 		 * allocated lock entry is not needed.
149*4882a593Smuzhiyun 		 */
150*4882a593Smuzhiyun 		le_free = le;
151*4882a593Smuzhiyun 		le = le1;
152*4882a593Smuzhiyun 	} else {
153*4882a593Smuzhiyun 		struct rb_node **p, *parent = NULL;
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun 		/*
156*4882a593Smuzhiyun 		 * No lock entry, add the newly allocated one to the
157*4882a593Smuzhiyun 		 * @ubi->ltree RB-tree.
158*4882a593Smuzhiyun 		 */
159*4882a593Smuzhiyun 		le_free = NULL;
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun 		p = &ubi->ltree.rb_node;
162*4882a593Smuzhiyun 		while (*p) {
163*4882a593Smuzhiyun 			parent = *p;
164*4882a593Smuzhiyun 			le1 = rb_entry(parent, struct ubi_ltree_entry, rb);
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun 			if (vol_id < le1->vol_id)
167*4882a593Smuzhiyun 				p = &(*p)->rb_left;
168*4882a593Smuzhiyun 			else if (vol_id > le1->vol_id)
169*4882a593Smuzhiyun 				p = &(*p)->rb_right;
170*4882a593Smuzhiyun 			else {
171*4882a593Smuzhiyun 				ubi_assert(lnum != le1->lnum);
172*4882a593Smuzhiyun 				if (lnum < le1->lnum)
173*4882a593Smuzhiyun 					p = &(*p)->rb_left;
174*4882a593Smuzhiyun 				else
175*4882a593Smuzhiyun 					p = &(*p)->rb_right;
176*4882a593Smuzhiyun 			}
177*4882a593Smuzhiyun 		}
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun 		rb_link_node(&le->rb, parent, p);
180*4882a593Smuzhiyun 		rb_insert_color(&le->rb, &ubi->ltree);
181*4882a593Smuzhiyun 	}
182*4882a593Smuzhiyun 	le->users += 1;
183*4882a593Smuzhiyun 	spin_unlock(&ubi->ltree_lock);
184*4882a593Smuzhiyun 
185*4882a593Smuzhiyun 	kfree(le_free);
186*4882a593Smuzhiyun 	return le;
187*4882a593Smuzhiyun }
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun /**
190*4882a593Smuzhiyun  * leb_read_lock - lock logical eraseblock for reading.
191*4882a593Smuzhiyun  * @ubi: UBI device description object
192*4882a593Smuzhiyun  * @vol_id: volume ID
193*4882a593Smuzhiyun  * @lnum: logical eraseblock number
194*4882a593Smuzhiyun  *
195*4882a593Smuzhiyun  * This function locks a logical eraseblock for reading. Returns zero in case
196*4882a593Smuzhiyun  * of success and a negative error code in case of failure.
197*4882a593Smuzhiyun  */
leb_read_lock(struct ubi_device * ubi,int vol_id,int lnum)198*4882a593Smuzhiyun static int leb_read_lock(struct ubi_device *ubi, int vol_id, int lnum)
199*4882a593Smuzhiyun {
200*4882a593Smuzhiyun 	struct ubi_ltree_entry *le;
201*4882a593Smuzhiyun 
202*4882a593Smuzhiyun 	le = ltree_add_entry(ubi, vol_id, lnum);
203*4882a593Smuzhiyun 	if (IS_ERR(le))
204*4882a593Smuzhiyun 		return PTR_ERR(le);
205*4882a593Smuzhiyun 	down_read(&le->mutex);
206*4882a593Smuzhiyun 	return 0;
207*4882a593Smuzhiyun }
208*4882a593Smuzhiyun 
209*4882a593Smuzhiyun /**
210*4882a593Smuzhiyun  * leb_read_unlock - unlock logical eraseblock.
211*4882a593Smuzhiyun  * @ubi: UBI device description object
212*4882a593Smuzhiyun  * @vol_id: volume ID
213*4882a593Smuzhiyun  * @lnum: logical eraseblock number
214*4882a593Smuzhiyun  */
leb_read_unlock(struct ubi_device * ubi,int vol_id,int lnum)215*4882a593Smuzhiyun static void leb_read_unlock(struct ubi_device *ubi, int vol_id, int lnum)
216*4882a593Smuzhiyun {
217*4882a593Smuzhiyun 	struct ubi_ltree_entry *le;
218*4882a593Smuzhiyun 
219*4882a593Smuzhiyun 	spin_lock(&ubi->ltree_lock);
220*4882a593Smuzhiyun 	le = ltree_lookup(ubi, vol_id, lnum);
221*4882a593Smuzhiyun 	le->users -= 1;
222*4882a593Smuzhiyun 	ubi_assert(le->users >= 0);
223*4882a593Smuzhiyun 	up_read(&le->mutex);
224*4882a593Smuzhiyun 	if (le->users == 0) {
225*4882a593Smuzhiyun 		rb_erase(&le->rb, &ubi->ltree);
226*4882a593Smuzhiyun 		kfree(le);
227*4882a593Smuzhiyun 	}
228*4882a593Smuzhiyun 	spin_unlock(&ubi->ltree_lock);
229*4882a593Smuzhiyun }
230*4882a593Smuzhiyun 
231*4882a593Smuzhiyun /**
232*4882a593Smuzhiyun  * leb_write_lock - lock logical eraseblock for writing.
233*4882a593Smuzhiyun  * @ubi: UBI device description object
234*4882a593Smuzhiyun  * @vol_id: volume ID
235*4882a593Smuzhiyun  * @lnum: logical eraseblock number
236*4882a593Smuzhiyun  *
237*4882a593Smuzhiyun  * This function locks a logical eraseblock for writing. Returns zero in case
238*4882a593Smuzhiyun  * of success and a negative error code in case of failure.
239*4882a593Smuzhiyun  */
leb_write_lock(struct ubi_device * ubi,int vol_id,int lnum)240*4882a593Smuzhiyun static int leb_write_lock(struct ubi_device *ubi, int vol_id, int lnum)
241*4882a593Smuzhiyun {
242*4882a593Smuzhiyun 	struct ubi_ltree_entry *le;
243*4882a593Smuzhiyun 
244*4882a593Smuzhiyun 	le = ltree_add_entry(ubi, vol_id, lnum);
245*4882a593Smuzhiyun 	if (IS_ERR(le))
246*4882a593Smuzhiyun 		return PTR_ERR(le);
247*4882a593Smuzhiyun 	down_write(&le->mutex);
248*4882a593Smuzhiyun 	return 0;
249*4882a593Smuzhiyun }
250*4882a593Smuzhiyun 
251*4882a593Smuzhiyun /**
252*4882a593Smuzhiyun  * leb_write_lock - lock logical eraseblock for writing.
253*4882a593Smuzhiyun  * @ubi: UBI device description object
254*4882a593Smuzhiyun  * @vol_id: volume ID
255*4882a593Smuzhiyun  * @lnum: logical eraseblock number
256*4882a593Smuzhiyun  *
257*4882a593Smuzhiyun  * This function locks a logical eraseblock for writing if there is no
258*4882a593Smuzhiyun  * contention and does nothing if there is contention. Returns %0 in case of
259*4882a593Smuzhiyun  * success, %1 in case of contention, and and a negative error code in case of
260*4882a593Smuzhiyun  * failure.
261*4882a593Smuzhiyun  */
leb_write_trylock(struct ubi_device * ubi,int vol_id,int lnum)262*4882a593Smuzhiyun static int leb_write_trylock(struct ubi_device *ubi, int vol_id, int lnum)
263*4882a593Smuzhiyun {
264*4882a593Smuzhiyun 	struct ubi_ltree_entry *le;
265*4882a593Smuzhiyun 
266*4882a593Smuzhiyun 	le = ltree_add_entry(ubi, vol_id, lnum);
267*4882a593Smuzhiyun 	if (IS_ERR(le))
268*4882a593Smuzhiyun 		return PTR_ERR(le);
269*4882a593Smuzhiyun 	if (down_write_trylock(&le->mutex))
270*4882a593Smuzhiyun 		return 0;
271*4882a593Smuzhiyun 
272*4882a593Smuzhiyun 	/* Contention, cancel */
273*4882a593Smuzhiyun 	spin_lock(&ubi->ltree_lock);
274*4882a593Smuzhiyun 	le->users -= 1;
275*4882a593Smuzhiyun 	ubi_assert(le->users >= 0);
276*4882a593Smuzhiyun 	if (le->users == 0) {
277*4882a593Smuzhiyun 		rb_erase(&le->rb, &ubi->ltree);
278*4882a593Smuzhiyun 		kfree(le);
279*4882a593Smuzhiyun 	}
280*4882a593Smuzhiyun 	spin_unlock(&ubi->ltree_lock);
281*4882a593Smuzhiyun 
282*4882a593Smuzhiyun 	return 1;
283*4882a593Smuzhiyun }
284*4882a593Smuzhiyun 
285*4882a593Smuzhiyun /**
286*4882a593Smuzhiyun  * leb_write_unlock - unlock logical eraseblock.
287*4882a593Smuzhiyun  * @ubi: UBI device description object
288*4882a593Smuzhiyun  * @vol_id: volume ID
289*4882a593Smuzhiyun  * @lnum: logical eraseblock number
290*4882a593Smuzhiyun  */
leb_write_unlock(struct ubi_device * ubi,int vol_id,int lnum)291*4882a593Smuzhiyun static void leb_write_unlock(struct ubi_device *ubi, int vol_id, int lnum)
292*4882a593Smuzhiyun {
293*4882a593Smuzhiyun 	struct ubi_ltree_entry *le;
294*4882a593Smuzhiyun 
295*4882a593Smuzhiyun 	spin_lock(&ubi->ltree_lock);
296*4882a593Smuzhiyun 	le = ltree_lookup(ubi, vol_id, lnum);
297*4882a593Smuzhiyun 	le->users -= 1;
298*4882a593Smuzhiyun 	ubi_assert(le->users >= 0);
299*4882a593Smuzhiyun 	up_write(&le->mutex);
300*4882a593Smuzhiyun 	if (le->users == 0) {
301*4882a593Smuzhiyun 		rb_erase(&le->rb, &ubi->ltree);
302*4882a593Smuzhiyun 		kfree(le);
303*4882a593Smuzhiyun 	}
304*4882a593Smuzhiyun 	spin_unlock(&ubi->ltree_lock);
305*4882a593Smuzhiyun }
306*4882a593Smuzhiyun 
307*4882a593Smuzhiyun /**
308*4882a593Smuzhiyun  * ubi_eba_unmap_leb - un-map logical eraseblock.
309*4882a593Smuzhiyun  * @ubi: UBI device description object
310*4882a593Smuzhiyun  * @vol: volume description object
311*4882a593Smuzhiyun  * @lnum: logical eraseblock number
312*4882a593Smuzhiyun  *
313*4882a593Smuzhiyun  * This function un-maps logical eraseblock @lnum and schedules corresponding
314*4882a593Smuzhiyun  * physical eraseblock for erasure. Returns zero in case of success and a
315*4882a593Smuzhiyun  * negative error code in case of failure.
316*4882a593Smuzhiyun  */
ubi_eba_unmap_leb(struct ubi_device * ubi,struct ubi_volume * vol,int lnum)317*4882a593Smuzhiyun int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
318*4882a593Smuzhiyun 		      int lnum)
319*4882a593Smuzhiyun {
320*4882a593Smuzhiyun 	int err, pnum, vol_id = vol->vol_id;
321*4882a593Smuzhiyun 
322*4882a593Smuzhiyun 	if (ubi->ro_mode)
323*4882a593Smuzhiyun 		return -EROFS;
324*4882a593Smuzhiyun 
325*4882a593Smuzhiyun 	err = leb_write_lock(ubi, vol_id, lnum);
326*4882a593Smuzhiyun 	if (err)
327*4882a593Smuzhiyun 		return err;
328*4882a593Smuzhiyun 
329*4882a593Smuzhiyun 	pnum = vol->eba_tbl[lnum];
330*4882a593Smuzhiyun 	if (pnum < 0)
331*4882a593Smuzhiyun 		/* This logical eraseblock is already unmapped */
332*4882a593Smuzhiyun 		goto out_unlock;
333*4882a593Smuzhiyun 
334*4882a593Smuzhiyun 	dbg_eba("erase LEB %d:%d, PEB %d", vol_id, lnum, pnum);
335*4882a593Smuzhiyun 
336*4882a593Smuzhiyun 	down_read(&ubi->fm_eba_sem);
337*4882a593Smuzhiyun 	vol->eba_tbl[lnum] = UBI_LEB_UNMAPPED;
338*4882a593Smuzhiyun 	up_read(&ubi->fm_eba_sem);
339*4882a593Smuzhiyun 	err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 0);
340*4882a593Smuzhiyun 
341*4882a593Smuzhiyun out_unlock:
342*4882a593Smuzhiyun 	leb_write_unlock(ubi, vol_id, lnum);
343*4882a593Smuzhiyun 	return err;
344*4882a593Smuzhiyun }
345*4882a593Smuzhiyun 
346*4882a593Smuzhiyun /**
347*4882a593Smuzhiyun  * ubi_eba_read_leb - read data.
348*4882a593Smuzhiyun  * @ubi: UBI device description object
349*4882a593Smuzhiyun  * @vol: volume description object
350*4882a593Smuzhiyun  * @lnum: logical eraseblock number
351*4882a593Smuzhiyun  * @buf: buffer to store the read data
352*4882a593Smuzhiyun  * @offset: offset from where to read
353*4882a593Smuzhiyun  * @len: how many bytes to read
354*4882a593Smuzhiyun  * @check: data CRC check flag
355*4882a593Smuzhiyun  *
356*4882a593Smuzhiyun  * If the logical eraseblock @lnum is unmapped, @buf is filled with 0xFF
357*4882a593Smuzhiyun  * bytes. The @check flag only makes sense for static volumes and forces
358*4882a593Smuzhiyun  * eraseblock data CRC checking.
359*4882a593Smuzhiyun  *
360*4882a593Smuzhiyun  * In case of success this function returns zero. In case of a static volume,
361*4882a593Smuzhiyun  * if data CRC mismatches - %-EBADMSG is returned. %-EBADMSG may also be
362*4882a593Smuzhiyun  * returned for any volume type if an ECC error was detected by the MTD device
363*4882a593Smuzhiyun  * driver. Other negative error cored may be returned in case of other errors.
364*4882a593Smuzhiyun  */
ubi_eba_read_leb(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,void * buf,int offset,int len,int check)365*4882a593Smuzhiyun int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
366*4882a593Smuzhiyun 		     void *buf, int offset, int len, int check)
367*4882a593Smuzhiyun {
368*4882a593Smuzhiyun 	int err, pnum, scrub = 0, vol_id = vol->vol_id;
369*4882a593Smuzhiyun 	struct ubi_vid_hdr *vid_hdr;
370*4882a593Smuzhiyun 	uint32_t uninitialized_var(crc);
371*4882a593Smuzhiyun 
372*4882a593Smuzhiyun 	err = leb_read_lock(ubi, vol_id, lnum);
373*4882a593Smuzhiyun 	if (err)
374*4882a593Smuzhiyun 		return err;
375*4882a593Smuzhiyun 
376*4882a593Smuzhiyun 	pnum = vol->eba_tbl[lnum];
377*4882a593Smuzhiyun 	if (pnum < 0) {
378*4882a593Smuzhiyun 		/*
379*4882a593Smuzhiyun 		 * The logical eraseblock is not mapped, fill the whole buffer
380*4882a593Smuzhiyun 		 * with 0xFF bytes. The exception is static volumes for which
381*4882a593Smuzhiyun 		 * it is an error to read unmapped logical eraseblocks.
382*4882a593Smuzhiyun 		 */
383*4882a593Smuzhiyun 		dbg_eba("read %d bytes from offset %d of LEB %d:%d (unmapped)",
384*4882a593Smuzhiyun 			len, offset, vol_id, lnum);
385*4882a593Smuzhiyun 		leb_read_unlock(ubi, vol_id, lnum);
386*4882a593Smuzhiyun 		ubi_assert(vol->vol_type != UBI_STATIC_VOLUME);
387*4882a593Smuzhiyun 		memset(buf, 0xFF, len);
388*4882a593Smuzhiyun 		return 0;
389*4882a593Smuzhiyun 	}
390*4882a593Smuzhiyun 
391*4882a593Smuzhiyun 	dbg_eba("read %d bytes from offset %d of LEB %d:%d, PEB %d",
392*4882a593Smuzhiyun 		len, offset, vol_id, lnum, pnum);
393*4882a593Smuzhiyun 
394*4882a593Smuzhiyun 	if (vol->vol_type == UBI_DYNAMIC_VOLUME)
395*4882a593Smuzhiyun 		check = 0;
396*4882a593Smuzhiyun 
397*4882a593Smuzhiyun retry:
398*4882a593Smuzhiyun 	if (check) {
399*4882a593Smuzhiyun 		vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
400*4882a593Smuzhiyun 		if (!vid_hdr) {
401*4882a593Smuzhiyun 			err = -ENOMEM;
402*4882a593Smuzhiyun 			goto out_unlock;
403*4882a593Smuzhiyun 		}
404*4882a593Smuzhiyun 
405*4882a593Smuzhiyun 		err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
406*4882a593Smuzhiyun 		if (err && err != UBI_IO_BITFLIPS) {
407*4882a593Smuzhiyun 			if (err > 0) {
408*4882a593Smuzhiyun 				/*
409*4882a593Smuzhiyun 				 * The header is either absent or corrupted.
410*4882a593Smuzhiyun 				 * The former case means there is a bug -
411*4882a593Smuzhiyun 				 * switch to read-only mode just in case.
412*4882a593Smuzhiyun 				 * The latter case means a real corruption - we
413*4882a593Smuzhiyun 				 * may try to recover data. FIXME: but this is
414*4882a593Smuzhiyun 				 * not implemented.
415*4882a593Smuzhiyun 				 */
416*4882a593Smuzhiyun 				if (err == UBI_IO_BAD_HDR_EBADMSG ||
417*4882a593Smuzhiyun 				    err == UBI_IO_BAD_HDR) {
418*4882a593Smuzhiyun 					ubi_warn(ubi, "corrupted VID header at PEB %d, LEB %d:%d",
419*4882a593Smuzhiyun 						 pnum, vol_id, lnum);
420*4882a593Smuzhiyun 					err = -EBADMSG;
421*4882a593Smuzhiyun 				} else {
422*4882a593Smuzhiyun 					err = -EINVAL;
423*4882a593Smuzhiyun 					ubi_ro_mode(ubi);
424*4882a593Smuzhiyun 				}
425*4882a593Smuzhiyun 			}
426*4882a593Smuzhiyun 			goto out_free;
427*4882a593Smuzhiyun 		} else if (err == UBI_IO_BITFLIPS)
428*4882a593Smuzhiyun 			scrub = 1;
429*4882a593Smuzhiyun 
430*4882a593Smuzhiyun 		ubi_assert(lnum < be32_to_cpu(vid_hdr->used_ebs));
431*4882a593Smuzhiyun 		ubi_assert(len == be32_to_cpu(vid_hdr->data_size));
432*4882a593Smuzhiyun 
433*4882a593Smuzhiyun 		crc = be32_to_cpu(vid_hdr->data_crc);
434*4882a593Smuzhiyun 		ubi_free_vid_hdr(ubi, vid_hdr);
435*4882a593Smuzhiyun 	}
436*4882a593Smuzhiyun 
437*4882a593Smuzhiyun 	err = ubi_io_read_data(ubi, buf, pnum, offset, len);
438*4882a593Smuzhiyun 	if (err) {
439*4882a593Smuzhiyun 		if (err == UBI_IO_BITFLIPS)
440*4882a593Smuzhiyun 			scrub = 1;
441*4882a593Smuzhiyun 		else if (mtd_is_eccerr(err)) {
442*4882a593Smuzhiyun 			if (vol->vol_type == UBI_DYNAMIC_VOLUME)
443*4882a593Smuzhiyun 				goto out_unlock;
444*4882a593Smuzhiyun 			scrub = 1;
445*4882a593Smuzhiyun 			if (!check) {
446*4882a593Smuzhiyun 				ubi_msg(ubi, "force data checking");
447*4882a593Smuzhiyun 				check = 1;
448*4882a593Smuzhiyun 				goto retry;
449*4882a593Smuzhiyun 			}
450*4882a593Smuzhiyun 		} else
451*4882a593Smuzhiyun 			goto out_unlock;
452*4882a593Smuzhiyun 	}
453*4882a593Smuzhiyun 
454*4882a593Smuzhiyun 	if (check) {
455*4882a593Smuzhiyun 		uint32_t crc1 = crc32(UBI_CRC32_INIT, buf, len);
456*4882a593Smuzhiyun 		if (crc1 != crc) {
457*4882a593Smuzhiyun 			ubi_warn(ubi, "CRC error: calculated %#08x, must be %#08x",
458*4882a593Smuzhiyun 				 crc1, crc);
459*4882a593Smuzhiyun 			err = -EBADMSG;
460*4882a593Smuzhiyun 			goto out_unlock;
461*4882a593Smuzhiyun 		}
462*4882a593Smuzhiyun 	}
463*4882a593Smuzhiyun 
464*4882a593Smuzhiyun 	if (scrub)
465*4882a593Smuzhiyun 		err = ubi_wl_scrub_peb(ubi, pnum);
466*4882a593Smuzhiyun 
467*4882a593Smuzhiyun 	leb_read_unlock(ubi, vol_id, lnum);
468*4882a593Smuzhiyun 	return err;
469*4882a593Smuzhiyun 
470*4882a593Smuzhiyun out_free:
471*4882a593Smuzhiyun 	ubi_free_vid_hdr(ubi, vid_hdr);
472*4882a593Smuzhiyun out_unlock:
473*4882a593Smuzhiyun 	leb_read_unlock(ubi, vol_id, lnum);
474*4882a593Smuzhiyun 	return err;
475*4882a593Smuzhiyun }
476*4882a593Smuzhiyun 
477*4882a593Smuzhiyun #ifndef __UBOOT__
478*4882a593Smuzhiyun /**
479*4882a593Smuzhiyun  * ubi_eba_read_leb_sg - read data into a scatter gather list.
480*4882a593Smuzhiyun  * @ubi: UBI device description object
481*4882a593Smuzhiyun  * @vol: volume description object
482*4882a593Smuzhiyun  * @lnum: logical eraseblock number
483*4882a593Smuzhiyun  * @sgl: UBI scatter gather list to store the read data
484*4882a593Smuzhiyun  * @offset: offset from where to read
485*4882a593Smuzhiyun  * @len: how many bytes to read
486*4882a593Smuzhiyun  * @check: data CRC check flag
487*4882a593Smuzhiyun  *
488*4882a593Smuzhiyun  * This function works exactly like ubi_eba_read_leb(). But instead of
489*4882a593Smuzhiyun  * storing the read data into a buffer it writes to an UBI scatter gather
490*4882a593Smuzhiyun  * list.
491*4882a593Smuzhiyun  */
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*4882a593Smuzhiyun int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
493*4882a593Smuzhiyun 			struct ubi_sgl *sgl, int lnum, int offset, int len,
494*4882a593Smuzhiyun 			int check)
495*4882a593Smuzhiyun {
496*4882a593Smuzhiyun 	int to_read;
497*4882a593Smuzhiyun 	int ret;
498*4882a593Smuzhiyun 	struct scatterlist *sg;
499*4882a593Smuzhiyun 
500*4882a593Smuzhiyun 	for (;;) {
501*4882a593Smuzhiyun 		ubi_assert(sgl->list_pos < UBI_MAX_SG_COUNT);
502*4882a593Smuzhiyun 		sg = &sgl->sg[sgl->list_pos];
503*4882a593Smuzhiyun 		if (len < sg->length - sgl->page_pos)
504*4882a593Smuzhiyun 			to_read = len;
505*4882a593Smuzhiyun 		else
506*4882a593Smuzhiyun 			to_read = sg->length - sgl->page_pos;
507*4882a593Smuzhiyun 
508*4882a593Smuzhiyun 		ret = ubi_eba_read_leb(ubi, vol, lnum,
509*4882a593Smuzhiyun 				       sg_virt(sg) + sgl->page_pos, offset,
510*4882a593Smuzhiyun 				       to_read, check);
511*4882a593Smuzhiyun 		if (ret < 0)
512*4882a593Smuzhiyun 			return ret;
513*4882a593Smuzhiyun 
514*4882a593Smuzhiyun 		offset += to_read;
515*4882a593Smuzhiyun 		len -= to_read;
516*4882a593Smuzhiyun 		if (!len) {
517*4882a593Smuzhiyun 			sgl->page_pos += to_read;
518*4882a593Smuzhiyun 			if (sgl->page_pos == sg->length) {
519*4882a593Smuzhiyun 				sgl->list_pos++;
520*4882a593Smuzhiyun 				sgl->page_pos = 0;
521*4882a593Smuzhiyun 			}
522*4882a593Smuzhiyun 
523*4882a593Smuzhiyun 			break;
524*4882a593Smuzhiyun 		}
525*4882a593Smuzhiyun 
526*4882a593Smuzhiyun 		sgl->list_pos++;
527*4882a593Smuzhiyun 		sgl->page_pos = 0;
528*4882a593Smuzhiyun 	}
529*4882a593Smuzhiyun 
530*4882a593Smuzhiyun 	return ret;
531*4882a593Smuzhiyun }
532*4882a593Smuzhiyun #endif
533*4882a593Smuzhiyun 
534*4882a593Smuzhiyun /**
535*4882a593Smuzhiyun  * recover_peb - recover from write failure.
536*4882a593Smuzhiyun  * @ubi: UBI device description object
537*4882a593Smuzhiyun  * @pnum: the physical eraseblock to recover
538*4882a593Smuzhiyun  * @vol_id: volume ID
539*4882a593Smuzhiyun  * @lnum: logical eraseblock number
540*4882a593Smuzhiyun  * @buf: data which was not written because of the write failure
541*4882a593Smuzhiyun  * @offset: offset of the failed write
542*4882a593Smuzhiyun  * @len: how many bytes should have been written
543*4882a593Smuzhiyun  *
544*4882a593Smuzhiyun  * This function is called in case of a write failure and moves all good data
545*4882a593Smuzhiyun  * from the potentially bad physical eraseblock to a good physical eraseblock.
546*4882a593Smuzhiyun  * This function also writes the data which was not written due to the failure.
547*4882a593Smuzhiyun  * Returns new physical eraseblock number in case of success, and a negative
548*4882a593Smuzhiyun  * error code in case of failure.
549*4882a593Smuzhiyun  */
recover_peb(struct ubi_device * ubi,int pnum,int vol_id,int lnum,const void * buf,int offset,int len)550*4882a593Smuzhiyun static int recover_peb(struct ubi_device *ubi, int pnum, int vol_id, int lnum,
551*4882a593Smuzhiyun 		       const void *buf, int offset, int len)
552*4882a593Smuzhiyun {
553*4882a593Smuzhiyun 	int err, idx = vol_id2idx(ubi, vol_id), new_pnum, data_size, tries = 0;
554*4882a593Smuzhiyun 	struct ubi_volume *vol = ubi->volumes[idx];
555*4882a593Smuzhiyun 	struct ubi_vid_hdr *vid_hdr;
556*4882a593Smuzhiyun 
557*4882a593Smuzhiyun 	vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
558*4882a593Smuzhiyun 	if (!vid_hdr)
559*4882a593Smuzhiyun 		return -ENOMEM;
560*4882a593Smuzhiyun 
561*4882a593Smuzhiyun retry:
562*4882a593Smuzhiyun 	new_pnum = ubi_wl_get_peb(ubi);
563*4882a593Smuzhiyun 	if (new_pnum < 0) {
564*4882a593Smuzhiyun 		ubi_free_vid_hdr(ubi, vid_hdr);
565*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
566*4882a593Smuzhiyun 		return new_pnum;
567*4882a593Smuzhiyun 	}
568*4882a593Smuzhiyun 
569*4882a593Smuzhiyun 	ubi_msg(ubi, "recover PEB %d, move data to PEB %d",
570*4882a593Smuzhiyun 		pnum, new_pnum);
571*4882a593Smuzhiyun 
572*4882a593Smuzhiyun 	err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
573*4882a593Smuzhiyun 	if (err && err != UBI_IO_BITFLIPS) {
574*4882a593Smuzhiyun 		if (err > 0)
575*4882a593Smuzhiyun 			err = -EIO;
576*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
577*4882a593Smuzhiyun 		goto out_put;
578*4882a593Smuzhiyun 	}
579*4882a593Smuzhiyun 
580*4882a593Smuzhiyun 	vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
581*4882a593Smuzhiyun 	err = ubi_io_write_vid_hdr(ubi, new_pnum, vid_hdr);
582*4882a593Smuzhiyun 	if (err) {
583*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
584*4882a593Smuzhiyun 		goto write_error;
585*4882a593Smuzhiyun 	}
586*4882a593Smuzhiyun 
587*4882a593Smuzhiyun 	data_size = offset + len;
588*4882a593Smuzhiyun 	mutex_lock(&ubi->buf_mutex);
589*4882a593Smuzhiyun 	memset(ubi->peb_buf + offset, 0xFF, len);
590*4882a593Smuzhiyun 
591*4882a593Smuzhiyun 	/* Read everything before the area where the write failure happened */
592*4882a593Smuzhiyun 	if (offset > 0) {
593*4882a593Smuzhiyun 		err = ubi_io_read_data(ubi, ubi->peb_buf, pnum, 0, offset);
594*4882a593Smuzhiyun 		if (err && err != UBI_IO_BITFLIPS) {
595*4882a593Smuzhiyun 			up_read(&ubi->fm_eba_sem);
596*4882a593Smuzhiyun 			goto out_unlock;
597*4882a593Smuzhiyun 		}
598*4882a593Smuzhiyun 	}
599*4882a593Smuzhiyun 
600*4882a593Smuzhiyun 	memcpy(ubi->peb_buf + offset, buf, len);
601*4882a593Smuzhiyun 
602*4882a593Smuzhiyun 	err = ubi_io_write_data(ubi, ubi->peb_buf, new_pnum, 0, data_size);
603*4882a593Smuzhiyun 	if (err) {
604*4882a593Smuzhiyun 		mutex_unlock(&ubi->buf_mutex);
605*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
606*4882a593Smuzhiyun 		goto write_error;
607*4882a593Smuzhiyun 	}
608*4882a593Smuzhiyun 
609*4882a593Smuzhiyun 	mutex_unlock(&ubi->buf_mutex);
610*4882a593Smuzhiyun 	ubi_free_vid_hdr(ubi, vid_hdr);
611*4882a593Smuzhiyun 
612*4882a593Smuzhiyun 	vol->eba_tbl[lnum] = new_pnum;
613*4882a593Smuzhiyun 	up_read(&ubi->fm_eba_sem);
614*4882a593Smuzhiyun 	ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
615*4882a593Smuzhiyun 
616*4882a593Smuzhiyun 	ubi_msg(ubi, "data was successfully recovered");
617*4882a593Smuzhiyun 	return 0;
618*4882a593Smuzhiyun 
619*4882a593Smuzhiyun out_unlock:
620*4882a593Smuzhiyun 	mutex_unlock(&ubi->buf_mutex);
621*4882a593Smuzhiyun out_put:
622*4882a593Smuzhiyun 	ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
623*4882a593Smuzhiyun 	ubi_free_vid_hdr(ubi, vid_hdr);
624*4882a593Smuzhiyun 	return err;
625*4882a593Smuzhiyun 
626*4882a593Smuzhiyun write_error:
627*4882a593Smuzhiyun 	/*
628*4882a593Smuzhiyun 	 * Bad luck? This physical eraseblock is bad too? Crud. Let's try to
629*4882a593Smuzhiyun 	 * get another one.
630*4882a593Smuzhiyun 	 */
631*4882a593Smuzhiyun 	ubi_warn(ubi, "failed to write to PEB %d", new_pnum);
632*4882a593Smuzhiyun 	ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
633*4882a593Smuzhiyun 	if (++tries > UBI_IO_RETRIES) {
634*4882a593Smuzhiyun 		ubi_free_vid_hdr(ubi, vid_hdr);
635*4882a593Smuzhiyun 		return err;
636*4882a593Smuzhiyun 	}
637*4882a593Smuzhiyun 	ubi_msg(ubi, "try again");
638*4882a593Smuzhiyun 	goto retry;
639*4882a593Smuzhiyun }
640*4882a593Smuzhiyun 
641*4882a593Smuzhiyun /**
642*4882a593Smuzhiyun  * ubi_eba_write_leb - write data to dynamic volume.
643*4882a593Smuzhiyun  * @ubi: UBI device description object
644*4882a593Smuzhiyun  * @vol: volume description object
645*4882a593Smuzhiyun  * @lnum: logical eraseblock number
646*4882a593Smuzhiyun  * @buf: the data to write
647*4882a593Smuzhiyun  * @offset: offset within the logical eraseblock where to write
648*4882a593Smuzhiyun  * @len: how many bytes to write
649*4882a593Smuzhiyun  *
650*4882a593Smuzhiyun  * This function writes data to logical eraseblock @lnum of a dynamic volume
651*4882a593Smuzhiyun  * @vol. Returns zero in case of success and a negative error code in case
652*4882a593Smuzhiyun  * of failure. In case of error, it is possible that something was still
653*4882a593Smuzhiyun  * written to the flash media, but may be some garbage.
654*4882a593Smuzhiyun  */
ubi_eba_write_leb(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,const void * buf,int offset,int len)655*4882a593Smuzhiyun int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
656*4882a593Smuzhiyun 		      const void *buf, int offset, int len)
657*4882a593Smuzhiyun {
658*4882a593Smuzhiyun 	int err, pnum, tries = 0, vol_id = vol->vol_id;
659*4882a593Smuzhiyun 	struct ubi_vid_hdr *vid_hdr;
660*4882a593Smuzhiyun 
661*4882a593Smuzhiyun 	if (ubi->ro_mode)
662*4882a593Smuzhiyun 		return -EROFS;
663*4882a593Smuzhiyun 
664*4882a593Smuzhiyun 	err = leb_write_lock(ubi, vol_id, lnum);
665*4882a593Smuzhiyun 	if (err)
666*4882a593Smuzhiyun 		return err;
667*4882a593Smuzhiyun 
668*4882a593Smuzhiyun 	pnum = vol->eba_tbl[lnum];
669*4882a593Smuzhiyun 	if (pnum >= 0) {
670*4882a593Smuzhiyun 		dbg_eba("write %d bytes at offset %d of LEB %d:%d, PEB %d",
671*4882a593Smuzhiyun 			len, offset, vol_id, lnum, pnum);
672*4882a593Smuzhiyun 
673*4882a593Smuzhiyun 		err = ubi_io_write_data(ubi, buf, pnum, offset, len);
674*4882a593Smuzhiyun 		if (err) {
675*4882a593Smuzhiyun 			ubi_warn(ubi, "failed to write data to PEB %d", pnum);
676*4882a593Smuzhiyun 			if (err == -EIO && ubi->bad_allowed)
677*4882a593Smuzhiyun 				err = recover_peb(ubi, pnum, vol_id, lnum, buf,
678*4882a593Smuzhiyun 						  offset, len);
679*4882a593Smuzhiyun 			if (err)
680*4882a593Smuzhiyun 				ubi_ro_mode(ubi);
681*4882a593Smuzhiyun 		}
682*4882a593Smuzhiyun 		leb_write_unlock(ubi, vol_id, lnum);
683*4882a593Smuzhiyun 		return err;
684*4882a593Smuzhiyun 	}
685*4882a593Smuzhiyun 
686*4882a593Smuzhiyun 	/*
687*4882a593Smuzhiyun 	 * The logical eraseblock is not mapped. We have to get a free physical
688*4882a593Smuzhiyun 	 * eraseblock and write the volume identifier header there first.
689*4882a593Smuzhiyun 	 */
690*4882a593Smuzhiyun 	vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
691*4882a593Smuzhiyun 	if (!vid_hdr) {
692*4882a593Smuzhiyun 		leb_write_unlock(ubi, vol_id, lnum);
693*4882a593Smuzhiyun 		return -ENOMEM;
694*4882a593Smuzhiyun 	}
695*4882a593Smuzhiyun 
696*4882a593Smuzhiyun 	vid_hdr->vol_type = UBI_VID_DYNAMIC;
697*4882a593Smuzhiyun 	vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
698*4882a593Smuzhiyun 	vid_hdr->vol_id = cpu_to_be32(vol_id);
699*4882a593Smuzhiyun 	vid_hdr->lnum = cpu_to_be32(lnum);
700*4882a593Smuzhiyun 	vid_hdr->compat = ubi_get_compat(ubi, vol_id);
701*4882a593Smuzhiyun 	vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
702*4882a593Smuzhiyun 
703*4882a593Smuzhiyun retry:
704*4882a593Smuzhiyun 	pnum = ubi_wl_get_peb(ubi);
705*4882a593Smuzhiyun 	if (pnum < 0) {
706*4882a593Smuzhiyun 		ubi_free_vid_hdr(ubi, vid_hdr);
707*4882a593Smuzhiyun 		leb_write_unlock(ubi, vol_id, lnum);
708*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
709*4882a593Smuzhiyun 		return pnum;
710*4882a593Smuzhiyun 	}
711*4882a593Smuzhiyun 
712*4882a593Smuzhiyun 	dbg_eba("write VID hdr and %d bytes at offset %d of LEB %d:%d, PEB %d",
713*4882a593Smuzhiyun 		len, offset, vol_id, lnum, pnum);
714*4882a593Smuzhiyun 
715*4882a593Smuzhiyun 	err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
716*4882a593Smuzhiyun 	if (err) {
717*4882a593Smuzhiyun 		ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
718*4882a593Smuzhiyun 			 vol_id, lnum, pnum);
719*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
720*4882a593Smuzhiyun 		goto write_error;
721*4882a593Smuzhiyun 	}
722*4882a593Smuzhiyun 
723*4882a593Smuzhiyun 	if (len) {
724*4882a593Smuzhiyun 		err = ubi_io_write_data(ubi, buf, pnum, offset, len);
725*4882a593Smuzhiyun 		if (err) {
726*4882a593Smuzhiyun 			ubi_warn(ubi, "failed to write %d bytes at offset %d of LEB %d:%d, PEB %d",
727*4882a593Smuzhiyun 				 len, offset, vol_id, lnum, pnum);
728*4882a593Smuzhiyun 			up_read(&ubi->fm_eba_sem);
729*4882a593Smuzhiyun 			goto write_error;
730*4882a593Smuzhiyun 		}
731*4882a593Smuzhiyun 	}
732*4882a593Smuzhiyun 
733*4882a593Smuzhiyun 	vol->eba_tbl[lnum] = pnum;
734*4882a593Smuzhiyun 	up_read(&ubi->fm_eba_sem);
735*4882a593Smuzhiyun 
736*4882a593Smuzhiyun 	leb_write_unlock(ubi, vol_id, lnum);
737*4882a593Smuzhiyun 	ubi_free_vid_hdr(ubi, vid_hdr);
738*4882a593Smuzhiyun 	return 0;
739*4882a593Smuzhiyun 
740*4882a593Smuzhiyun write_error:
741*4882a593Smuzhiyun 	if (err != -EIO || !ubi->bad_allowed) {
742*4882a593Smuzhiyun 		ubi_ro_mode(ubi);
743*4882a593Smuzhiyun 		leb_write_unlock(ubi, vol_id, lnum);
744*4882a593Smuzhiyun 		ubi_free_vid_hdr(ubi, vid_hdr);
745*4882a593Smuzhiyun 		return err;
746*4882a593Smuzhiyun 	}
747*4882a593Smuzhiyun 
748*4882a593Smuzhiyun 	/*
749*4882a593Smuzhiyun 	 * Fortunately, this is the first write operation to this physical
750*4882a593Smuzhiyun 	 * eraseblock, so just put it and request a new one. We assume that if
751*4882a593Smuzhiyun 	 * this physical eraseblock went bad, the erase code will handle that.
752*4882a593Smuzhiyun 	 */
753*4882a593Smuzhiyun 	err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
754*4882a593Smuzhiyun 	if (err || ++tries > UBI_IO_RETRIES) {
755*4882a593Smuzhiyun 		ubi_ro_mode(ubi);
756*4882a593Smuzhiyun 		leb_write_unlock(ubi, vol_id, lnum);
757*4882a593Smuzhiyun 		ubi_free_vid_hdr(ubi, vid_hdr);
758*4882a593Smuzhiyun 		return err;
759*4882a593Smuzhiyun 	}
760*4882a593Smuzhiyun 
761*4882a593Smuzhiyun 	vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
762*4882a593Smuzhiyun 	ubi_msg(ubi, "try another PEB");
763*4882a593Smuzhiyun 	goto retry;
764*4882a593Smuzhiyun }
765*4882a593Smuzhiyun 
766*4882a593Smuzhiyun /**
767*4882a593Smuzhiyun  * ubi_eba_write_leb_st - write data to static volume.
768*4882a593Smuzhiyun  * @ubi: UBI device description object
769*4882a593Smuzhiyun  * @vol: volume description object
770*4882a593Smuzhiyun  * @lnum: logical eraseblock number
771*4882a593Smuzhiyun  * @buf: data to write
772*4882a593Smuzhiyun  * @len: how many bytes to write
773*4882a593Smuzhiyun  * @used_ebs: how many logical eraseblocks will this volume contain
774*4882a593Smuzhiyun  *
775*4882a593Smuzhiyun  * This function writes data to logical eraseblock @lnum of static volume
776*4882a593Smuzhiyun  * @vol. The @used_ebs argument should contain total number of logical
777*4882a593Smuzhiyun  * eraseblock in this static volume.
778*4882a593Smuzhiyun  *
779*4882a593Smuzhiyun  * When writing to the last logical eraseblock, the @len argument doesn't have
780*4882a593Smuzhiyun  * to be aligned to the minimal I/O unit size. Instead, it has to be equivalent
781*4882a593Smuzhiyun  * to the real data size, although the @buf buffer has to contain the
782*4882a593Smuzhiyun  * alignment. In all other cases, @len has to be aligned.
783*4882a593Smuzhiyun  *
784*4882a593Smuzhiyun  * It is prohibited to write more than once to logical eraseblocks of static
785*4882a593Smuzhiyun  * volumes. This function returns zero in case of success and a negative error
786*4882a593Smuzhiyun  * code in case of failure.
787*4882a593Smuzhiyun  */
ubi_eba_write_leb_st(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,const void * buf,int len,int used_ebs)788*4882a593Smuzhiyun int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
789*4882a593Smuzhiyun 			 int lnum, const void *buf, int len, int used_ebs)
790*4882a593Smuzhiyun {
791*4882a593Smuzhiyun 	int err, pnum, tries = 0, data_size = len, vol_id = vol->vol_id;
792*4882a593Smuzhiyun 	struct ubi_vid_hdr *vid_hdr;
793*4882a593Smuzhiyun 	uint32_t crc;
794*4882a593Smuzhiyun 
795*4882a593Smuzhiyun 	if (ubi->ro_mode)
796*4882a593Smuzhiyun 		return -EROFS;
797*4882a593Smuzhiyun 
798*4882a593Smuzhiyun 	if (lnum == used_ebs - 1)
799*4882a593Smuzhiyun 		/* If this is the last LEB @len may be unaligned */
800*4882a593Smuzhiyun 		len = ALIGN(data_size, ubi->min_io_size);
801*4882a593Smuzhiyun 	else
802*4882a593Smuzhiyun 		ubi_assert(!(len & (ubi->min_io_size - 1)));
803*4882a593Smuzhiyun 
804*4882a593Smuzhiyun 	vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
805*4882a593Smuzhiyun 	if (!vid_hdr)
806*4882a593Smuzhiyun 		return -ENOMEM;
807*4882a593Smuzhiyun 
808*4882a593Smuzhiyun 	err = leb_write_lock(ubi, vol_id, lnum);
809*4882a593Smuzhiyun 	if (err) {
810*4882a593Smuzhiyun 		ubi_free_vid_hdr(ubi, vid_hdr);
811*4882a593Smuzhiyun 		return err;
812*4882a593Smuzhiyun 	}
813*4882a593Smuzhiyun 
814*4882a593Smuzhiyun 	vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
815*4882a593Smuzhiyun 	vid_hdr->vol_id = cpu_to_be32(vol_id);
816*4882a593Smuzhiyun 	vid_hdr->lnum = cpu_to_be32(lnum);
817*4882a593Smuzhiyun 	vid_hdr->compat = ubi_get_compat(ubi, vol_id);
818*4882a593Smuzhiyun 	vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
819*4882a593Smuzhiyun 
820*4882a593Smuzhiyun 	crc = crc32(UBI_CRC32_INIT, buf, data_size);
821*4882a593Smuzhiyun 	vid_hdr->vol_type = UBI_VID_STATIC;
822*4882a593Smuzhiyun 	vid_hdr->data_size = cpu_to_be32(data_size);
823*4882a593Smuzhiyun 	vid_hdr->used_ebs = cpu_to_be32(used_ebs);
824*4882a593Smuzhiyun 	vid_hdr->data_crc = cpu_to_be32(crc);
825*4882a593Smuzhiyun 
826*4882a593Smuzhiyun retry:
827*4882a593Smuzhiyun 	pnum = ubi_wl_get_peb(ubi);
828*4882a593Smuzhiyun 	if (pnum < 0) {
829*4882a593Smuzhiyun 		ubi_free_vid_hdr(ubi, vid_hdr);
830*4882a593Smuzhiyun 		leb_write_unlock(ubi, vol_id, lnum);
831*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
832*4882a593Smuzhiyun 		return pnum;
833*4882a593Smuzhiyun 	}
834*4882a593Smuzhiyun 
835*4882a593Smuzhiyun 	dbg_eba("write VID hdr and %d bytes at LEB %d:%d, PEB %d, used_ebs %d",
836*4882a593Smuzhiyun 		len, vol_id, lnum, pnum, used_ebs);
837*4882a593Smuzhiyun 
838*4882a593Smuzhiyun 	err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
839*4882a593Smuzhiyun 	if (err) {
840*4882a593Smuzhiyun 		ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
841*4882a593Smuzhiyun 			 vol_id, lnum, pnum);
842*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
843*4882a593Smuzhiyun 		goto write_error;
844*4882a593Smuzhiyun 	}
845*4882a593Smuzhiyun 
846*4882a593Smuzhiyun 	err = ubi_io_write_data(ubi, buf, pnum, 0, len);
847*4882a593Smuzhiyun 	if (err) {
848*4882a593Smuzhiyun 		ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
849*4882a593Smuzhiyun 			 len, pnum);
850*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
851*4882a593Smuzhiyun 		goto write_error;
852*4882a593Smuzhiyun 	}
853*4882a593Smuzhiyun 
854*4882a593Smuzhiyun 	ubi_assert(vol->eba_tbl[lnum] < 0);
855*4882a593Smuzhiyun 	vol->eba_tbl[lnum] = pnum;
856*4882a593Smuzhiyun 	up_read(&ubi->fm_eba_sem);
857*4882a593Smuzhiyun 
858*4882a593Smuzhiyun 	leb_write_unlock(ubi, vol_id, lnum);
859*4882a593Smuzhiyun 	ubi_free_vid_hdr(ubi, vid_hdr);
860*4882a593Smuzhiyun 	return 0;
861*4882a593Smuzhiyun 
862*4882a593Smuzhiyun write_error:
863*4882a593Smuzhiyun 	if (err != -EIO || !ubi->bad_allowed) {
864*4882a593Smuzhiyun 		/*
865*4882a593Smuzhiyun 		 * This flash device does not admit of bad eraseblocks or
866*4882a593Smuzhiyun 		 * something nasty and unexpected happened. Switch to read-only
867*4882a593Smuzhiyun 		 * mode just in case.
868*4882a593Smuzhiyun 		 */
869*4882a593Smuzhiyun 		ubi_ro_mode(ubi);
870*4882a593Smuzhiyun 		leb_write_unlock(ubi, vol_id, lnum);
871*4882a593Smuzhiyun 		ubi_free_vid_hdr(ubi, vid_hdr);
872*4882a593Smuzhiyun 		return err;
873*4882a593Smuzhiyun 	}
874*4882a593Smuzhiyun 
875*4882a593Smuzhiyun 	err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
876*4882a593Smuzhiyun 	if (err || ++tries > UBI_IO_RETRIES) {
877*4882a593Smuzhiyun 		ubi_ro_mode(ubi);
878*4882a593Smuzhiyun 		leb_write_unlock(ubi, vol_id, lnum);
879*4882a593Smuzhiyun 		ubi_free_vid_hdr(ubi, vid_hdr);
880*4882a593Smuzhiyun 		return err;
881*4882a593Smuzhiyun 	}
882*4882a593Smuzhiyun 
883*4882a593Smuzhiyun 	vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
884*4882a593Smuzhiyun 	ubi_msg(ubi, "try another PEB");
885*4882a593Smuzhiyun 	goto retry;
886*4882a593Smuzhiyun }
887*4882a593Smuzhiyun 
888*4882a593Smuzhiyun /*
889*4882a593Smuzhiyun  * ubi_eba_atomic_leb_change - change logical eraseblock atomically.
890*4882a593Smuzhiyun  * @ubi: UBI device description object
891*4882a593Smuzhiyun  * @vol: volume description object
892*4882a593Smuzhiyun  * @lnum: logical eraseblock number
893*4882a593Smuzhiyun  * @buf: data to write
894*4882a593Smuzhiyun  * @len: how many bytes to write
895*4882a593Smuzhiyun  *
896*4882a593Smuzhiyun  * This function changes the contents of a logical eraseblock atomically. @buf
897*4882a593Smuzhiyun  * has to contain new logical eraseblock data, and @len - the length of the
898*4882a593Smuzhiyun  * data, which has to be aligned. This function guarantees that in case of an
899*4882a593Smuzhiyun  * unclean reboot the old contents is preserved. Returns zero in case of
900*4882a593Smuzhiyun  * success and a negative error code in case of failure.
901*4882a593Smuzhiyun  *
902*4882a593Smuzhiyun  * UBI reserves one LEB for the "atomic LEB change" operation, so only one
903*4882a593Smuzhiyun  * LEB change may be done at a time. This is ensured by @ubi->alc_mutex.
904*4882a593Smuzhiyun  */
ubi_eba_atomic_leb_change(struct ubi_device * ubi,struct ubi_volume * vol,int lnum,const void * buf,int len)905*4882a593Smuzhiyun int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
906*4882a593Smuzhiyun 			      int lnum, const void *buf, int len)
907*4882a593Smuzhiyun {
908*4882a593Smuzhiyun 	int err, pnum, old_pnum, tries = 0, vol_id = vol->vol_id;
909*4882a593Smuzhiyun 	struct ubi_vid_hdr *vid_hdr;
910*4882a593Smuzhiyun 	uint32_t crc;
911*4882a593Smuzhiyun 
912*4882a593Smuzhiyun 	if (ubi->ro_mode)
913*4882a593Smuzhiyun 		return -EROFS;
914*4882a593Smuzhiyun 
915*4882a593Smuzhiyun 	if (len == 0) {
916*4882a593Smuzhiyun 		/*
917*4882a593Smuzhiyun 		 * Special case when data length is zero. In this case the LEB
918*4882a593Smuzhiyun 		 * has to be unmapped and mapped somewhere else.
919*4882a593Smuzhiyun 		 */
920*4882a593Smuzhiyun 		err = ubi_eba_unmap_leb(ubi, vol, lnum);
921*4882a593Smuzhiyun 		if (err)
922*4882a593Smuzhiyun 			return err;
923*4882a593Smuzhiyun 		return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0);
924*4882a593Smuzhiyun 	}
925*4882a593Smuzhiyun 
926*4882a593Smuzhiyun 	vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
927*4882a593Smuzhiyun 	if (!vid_hdr)
928*4882a593Smuzhiyun 		return -ENOMEM;
929*4882a593Smuzhiyun 
930*4882a593Smuzhiyun 	mutex_lock(&ubi->alc_mutex);
931*4882a593Smuzhiyun 	err = leb_write_lock(ubi, vol_id, lnum);
932*4882a593Smuzhiyun 	if (err)
933*4882a593Smuzhiyun 		goto out_mutex;
934*4882a593Smuzhiyun 
935*4882a593Smuzhiyun 	vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
936*4882a593Smuzhiyun 	vid_hdr->vol_id = cpu_to_be32(vol_id);
937*4882a593Smuzhiyun 	vid_hdr->lnum = cpu_to_be32(lnum);
938*4882a593Smuzhiyun 	vid_hdr->compat = ubi_get_compat(ubi, vol_id);
939*4882a593Smuzhiyun 	vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
940*4882a593Smuzhiyun 
941*4882a593Smuzhiyun 	crc = crc32(UBI_CRC32_INIT, buf, len);
942*4882a593Smuzhiyun 	vid_hdr->vol_type = UBI_VID_DYNAMIC;
943*4882a593Smuzhiyun 	vid_hdr->data_size = cpu_to_be32(len);
944*4882a593Smuzhiyun 	vid_hdr->copy_flag = 1;
945*4882a593Smuzhiyun 	vid_hdr->data_crc = cpu_to_be32(crc);
946*4882a593Smuzhiyun 
947*4882a593Smuzhiyun retry:
948*4882a593Smuzhiyun 	pnum = ubi_wl_get_peb(ubi);
949*4882a593Smuzhiyun 	if (pnum < 0) {
950*4882a593Smuzhiyun 		err = pnum;
951*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
952*4882a593Smuzhiyun 		goto out_leb_unlock;
953*4882a593Smuzhiyun 	}
954*4882a593Smuzhiyun 
955*4882a593Smuzhiyun 	dbg_eba("change LEB %d:%d, PEB %d, write VID hdr to PEB %d",
956*4882a593Smuzhiyun 		vol_id, lnum, vol->eba_tbl[lnum], pnum);
957*4882a593Smuzhiyun 
958*4882a593Smuzhiyun 	err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
959*4882a593Smuzhiyun 	if (err) {
960*4882a593Smuzhiyun 		ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
961*4882a593Smuzhiyun 			 vol_id, lnum, pnum);
962*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
963*4882a593Smuzhiyun 		goto write_error;
964*4882a593Smuzhiyun 	}
965*4882a593Smuzhiyun 
966*4882a593Smuzhiyun 	err = ubi_io_write_data(ubi, buf, pnum, 0, len);
967*4882a593Smuzhiyun 	if (err) {
968*4882a593Smuzhiyun 		ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
969*4882a593Smuzhiyun 			 len, pnum);
970*4882a593Smuzhiyun 		up_read(&ubi->fm_eba_sem);
971*4882a593Smuzhiyun 		goto write_error;
972*4882a593Smuzhiyun 	}
973*4882a593Smuzhiyun 
974*4882a593Smuzhiyun 	old_pnum = vol->eba_tbl[lnum];
975*4882a593Smuzhiyun 	vol->eba_tbl[lnum] = pnum;
976*4882a593Smuzhiyun 	up_read(&ubi->fm_eba_sem);
977*4882a593Smuzhiyun 
978*4882a593Smuzhiyun 	if (old_pnum >= 0) {
979*4882a593Smuzhiyun 		err = ubi_wl_put_peb(ubi, vol_id, lnum, old_pnum, 0);
980*4882a593Smuzhiyun 		if (err)
981*4882a593Smuzhiyun 			goto out_leb_unlock;
982*4882a593Smuzhiyun 	}
983*4882a593Smuzhiyun 
984*4882a593Smuzhiyun out_leb_unlock:
985*4882a593Smuzhiyun 	leb_write_unlock(ubi, vol_id, lnum);
986*4882a593Smuzhiyun out_mutex:
987*4882a593Smuzhiyun 	mutex_unlock(&ubi->alc_mutex);
988*4882a593Smuzhiyun 	ubi_free_vid_hdr(ubi, vid_hdr);
989*4882a593Smuzhiyun 	return err;
990*4882a593Smuzhiyun 
991*4882a593Smuzhiyun write_error:
992*4882a593Smuzhiyun 	if (err != -EIO || !ubi->bad_allowed) {
993*4882a593Smuzhiyun 		/*
994*4882a593Smuzhiyun 		 * This flash device does not admit of bad eraseblocks or
995*4882a593Smuzhiyun 		 * something nasty and unexpected happened. Switch to read-only
996*4882a593Smuzhiyun 		 * mode just in case.
997*4882a593Smuzhiyun 		 */
998*4882a593Smuzhiyun 		ubi_ro_mode(ubi);
999*4882a593Smuzhiyun 		goto out_leb_unlock;
1000*4882a593Smuzhiyun 	}
1001*4882a593Smuzhiyun 
1002*4882a593Smuzhiyun 	err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
1003*4882a593Smuzhiyun 	if (err || ++tries > UBI_IO_RETRIES) {
1004*4882a593Smuzhiyun 		ubi_ro_mode(ubi);
1005*4882a593Smuzhiyun 		goto out_leb_unlock;
1006*4882a593Smuzhiyun 	}
1007*4882a593Smuzhiyun 
1008*4882a593Smuzhiyun 	vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1009*4882a593Smuzhiyun 	ubi_msg(ubi, "try another PEB");
1010*4882a593Smuzhiyun 	goto retry;
1011*4882a593Smuzhiyun }
1012*4882a593Smuzhiyun 
1013*4882a593Smuzhiyun /**
1014*4882a593Smuzhiyun  * is_error_sane - check whether a read error is sane.
1015*4882a593Smuzhiyun  * @err: code of the error happened during reading
1016*4882a593Smuzhiyun  *
1017*4882a593Smuzhiyun  * This is a helper function for 'ubi_eba_copy_leb()' which is called when we
1018*4882a593Smuzhiyun  * cannot read data from the target PEB (an error @err happened). If the error
1019*4882a593Smuzhiyun  * code is sane, then we treat this error as non-fatal. Otherwise the error is
1020*4882a593Smuzhiyun  * fatal and UBI will be switched to R/O mode later.
1021*4882a593Smuzhiyun  *
1022*4882a593Smuzhiyun  * The idea is that we try not to switch to R/O mode if the read error is
1023*4882a593Smuzhiyun  * something which suggests there was a real read problem. E.g., %-EIO. Or a
1024*4882a593Smuzhiyun  * memory allocation failed (-%ENOMEM). Otherwise, it is safer to switch to R/O
1025*4882a593Smuzhiyun  * mode, simply because we do not know what happened at the MTD level, and we
1026*4882a593Smuzhiyun  * cannot handle this. E.g., the underlying driver may have become crazy, and
1027*4882a593Smuzhiyun  * it is safer to switch to R/O mode to preserve the data.
1028*4882a593Smuzhiyun  *
1029*4882a593Smuzhiyun  * And bear in mind, this is about reading from the target PEB, i.e. the PEB
1030*4882a593Smuzhiyun  * which we have just written.
1031*4882a593Smuzhiyun  */
is_error_sane(int err)1032*4882a593Smuzhiyun static int is_error_sane(int err)
1033*4882a593Smuzhiyun {
1034*4882a593Smuzhiyun 	if (err == -EIO || err == -ENOMEM || err == UBI_IO_BAD_HDR ||
1035*4882a593Smuzhiyun 	    err == UBI_IO_BAD_HDR_EBADMSG || err == -ETIMEDOUT)
1036*4882a593Smuzhiyun 		return 0;
1037*4882a593Smuzhiyun 	return 1;
1038*4882a593Smuzhiyun }
1039*4882a593Smuzhiyun 
1040*4882a593Smuzhiyun /**
1041*4882a593Smuzhiyun  * ubi_eba_copy_leb - copy logical eraseblock.
1042*4882a593Smuzhiyun  * @ubi: UBI device description object
1043*4882a593Smuzhiyun  * @from: physical eraseblock number from where to copy
1044*4882a593Smuzhiyun  * @to: physical eraseblock number where to copy
1045*4882a593Smuzhiyun  * @vid_hdr: VID header of the @from physical eraseblock
1046*4882a593Smuzhiyun  *
1047*4882a593Smuzhiyun  * This function copies logical eraseblock from physical eraseblock @from to
1048*4882a593Smuzhiyun  * physical eraseblock @to. The @vid_hdr buffer may be changed by this
1049*4882a593Smuzhiyun  * function. Returns:
1050*4882a593Smuzhiyun  *   o %0 in case of success;
1051*4882a593Smuzhiyun  *   o %MOVE_CANCEL_RACE, %MOVE_TARGET_WR_ERR, %MOVE_TARGET_BITFLIPS, etc;
1052*4882a593Smuzhiyun  *   o a negative error code in case of failure.
1053*4882a593Smuzhiyun  */
ubi_eba_copy_leb(struct ubi_device * ubi,int from,int to,struct ubi_vid_hdr * vid_hdr)1054*4882a593Smuzhiyun int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
1055*4882a593Smuzhiyun 		     struct ubi_vid_hdr *vid_hdr)
1056*4882a593Smuzhiyun {
1057*4882a593Smuzhiyun 	int err, vol_id, lnum, data_size, aldata_size, idx;
1058*4882a593Smuzhiyun 	struct ubi_volume *vol;
1059*4882a593Smuzhiyun 	uint32_t crc;
1060*4882a593Smuzhiyun 
1061*4882a593Smuzhiyun 	vol_id = be32_to_cpu(vid_hdr->vol_id);
1062*4882a593Smuzhiyun 	lnum = be32_to_cpu(vid_hdr->lnum);
1063*4882a593Smuzhiyun 
1064*4882a593Smuzhiyun 	dbg_wl("copy LEB %d:%d, PEB %d to PEB %d", vol_id, lnum, from, to);
1065*4882a593Smuzhiyun 
1066*4882a593Smuzhiyun 	if (vid_hdr->vol_type == UBI_VID_STATIC) {
1067*4882a593Smuzhiyun 		data_size = be32_to_cpu(vid_hdr->data_size);
1068*4882a593Smuzhiyun 		aldata_size = ALIGN(data_size, ubi->min_io_size);
1069*4882a593Smuzhiyun 	} else
1070*4882a593Smuzhiyun 		data_size = aldata_size =
1071*4882a593Smuzhiyun 			    ubi->leb_size - be32_to_cpu(vid_hdr->data_pad);
1072*4882a593Smuzhiyun 
1073*4882a593Smuzhiyun 	idx = vol_id2idx(ubi, vol_id);
1074*4882a593Smuzhiyun 	spin_lock(&ubi->volumes_lock);
1075*4882a593Smuzhiyun 	/*
1076*4882a593Smuzhiyun 	 * Note, we may race with volume deletion, which means that the volume
1077*4882a593Smuzhiyun 	 * this logical eraseblock belongs to might be being deleted. Since the
1078*4882a593Smuzhiyun 	 * volume deletion un-maps all the volume's logical eraseblocks, it will
1079*4882a593Smuzhiyun 	 * be locked in 'ubi_wl_put_peb()' and wait for the WL worker to finish.
1080*4882a593Smuzhiyun 	 */
1081*4882a593Smuzhiyun 	vol = ubi->volumes[idx];
1082*4882a593Smuzhiyun 	spin_unlock(&ubi->volumes_lock);
1083*4882a593Smuzhiyun 	if (!vol) {
1084*4882a593Smuzhiyun 		/* No need to do further work, cancel */
1085*4882a593Smuzhiyun 		dbg_wl("volume %d is being removed, cancel", vol_id);
1086*4882a593Smuzhiyun 		return MOVE_CANCEL_RACE;
1087*4882a593Smuzhiyun 	}
1088*4882a593Smuzhiyun 
1089*4882a593Smuzhiyun 	/*
1090*4882a593Smuzhiyun 	 * We do not want anybody to write to this logical eraseblock while we
1091*4882a593Smuzhiyun 	 * are moving it, so lock it.
1092*4882a593Smuzhiyun 	 *
1093*4882a593Smuzhiyun 	 * Note, we are using non-waiting locking here, because we cannot sleep
1094*4882a593Smuzhiyun 	 * on the LEB, since it may cause deadlocks. Indeed, imagine a task is
1095*4882a593Smuzhiyun 	 * unmapping the LEB which is mapped to the PEB we are going to move
1096*4882a593Smuzhiyun 	 * (@from). This task locks the LEB and goes sleep in the
1097*4882a593Smuzhiyun 	 * 'ubi_wl_put_peb()' function on the @ubi->move_mutex. In turn, we are
1098*4882a593Smuzhiyun 	 * holding @ubi->move_mutex and go sleep on the LEB lock. So, if the
1099*4882a593Smuzhiyun 	 * LEB is already locked, we just do not move it and return
1100*4882a593Smuzhiyun 	 * %MOVE_RETRY. Note, we do not return %MOVE_CANCEL_RACE here because
1101*4882a593Smuzhiyun 	 * we do not know the reasons of the contention - it may be just a
1102*4882a593Smuzhiyun 	 * normal I/O on this LEB, so we want to re-try.
1103*4882a593Smuzhiyun 	 */
1104*4882a593Smuzhiyun 	err = leb_write_trylock(ubi, vol_id, lnum);
1105*4882a593Smuzhiyun 	if (err) {
1106*4882a593Smuzhiyun 		dbg_wl("contention on LEB %d:%d, cancel", vol_id, lnum);
1107*4882a593Smuzhiyun 		return MOVE_RETRY;
1108*4882a593Smuzhiyun 	}
1109*4882a593Smuzhiyun 
1110*4882a593Smuzhiyun 	/*
1111*4882a593Smuzhiyun 	 * The LEB might have been put meanwhile, and the task which put it is
1112*4882a593Smuzhiyun 	 * probably waiting on @ubi->move_mutex. No need to continue the work,
1113*4882a593Smuzhiyun 	 * cancel it.
1114*4882a593Smuzhiyun 	 */
1115*4882a593Smuzhiyun 	if (vol->eba_tbl[lnum] != from) {
1116*4882a593Smuzhiyun 		dbg_wl("LEB %d:%d is no longer mapped to PEB %d, mapped to PEB %d, cancel",
1117*4882a593Smuzhiyun 		       vol_id, lnum, from, vol->eba_tbl[lnum]);
1118*4882a593Smuzhiyun 		err = MOVE_CANCEL_RACE;
1119*4882a593Smuzhiyun 		goto out_unlock_leb;
1120*4882a593Smuzhiyun 	}
1121*4882a593Smuzhiyun 
1122*4882a593Smuzhiyun 	/*
1123*4882a593Smuzhiyun 	 * OK, now the LEB is locked and we can safely start moving it. Since
1124*4882a593Smuzhiyun 	 * this function utilizes the @ubi->peb_buf buffer which is shared
1125*4882a593Smuzhiyun 	 * with some other functions - we lock the buffer by taking the
1126*4882a593Smuzhiyun 	 * @ubi->buf_mutex.
1127*4882a593Smuzhiyun 	 */
1128*4882a593Smuzhiyun 	mutex_lock(&ubi->buf_mutex);
1129*4882a593Smuzhiyun 	dbg_wl("read %d bytes of data", aldata_size);
1130*4882a593Smuzhiyun 	err = ubi_io_read_data(ubi, ubi->peb_buf, from, 0, aldata_size);
1131*4882a593Smuzhiyun 	if (err && err != UBI_IO_BITFLIPS) {
1132*4882a593Smuzhiyun 		ubi_warn(ubi, "error %d while reading data from PEB %d",
1133*4882a593Smuzhiyun 			 err, from);
1134*4882a593Smuzhiyun 		err = MOVE_SOURCE_RD_ERR;
1135*4882a593Smuzhiyun 		goto out_unlock_buf;
1136*4882a593Smuzhiyun 	}
1137*4882a593Smuzhiyun 
1138*4882a593Smuzhiyun 	/*
1139*4882a593Smuzhiyun 	 * Now we have got to calculate how much data we have to copy. In
1140*4882a593Smuzhiyun 	 * case of a static volume it is fairly easy - the VID header contains
1141*4882a593Smuzhiyun 	 * the data size. In case of a dynamic volume it is more difficult - we
1142*4882a593Smuzhiyun 	 * have to read the contents, cut 0xFF bytes from the end and copy only
1143*4882a593Smuzhiyun 	 * the first part. We must do this to avoid writing 0xFF bytes as it
1144*4882a593Smuzhiyun 	 * may have some side-effects. And not only this. It is important not
1145*4882a593Smuzhiyun 	 * to include those 0xFFs to CRC because later the they may be filled
1146*4882a593Smuzhiyun 	 * by data.
1147*4882a593Smuzhiyun 	 */
1148*4882a593Smuzhiyun 	if (vid_hdr->vol_type == UBI_VID_DYNAMIC)
1149*4882a593Smuzhiyun 		aldata_size = data_size =
1150*4882a593Smuzhiyun 			ubi_calc_data_len(ubi, ubi->peb_buf, data_size);
1151*4882a593Smuzhiyun 
1152*4882a593Smuzhiyun 	cond_resched();
1153*4882a593Smuzhiyun 	crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
1154*4882a593Smuzhiyun 	cond_resched();
1155*4882a593Smuzhiyun 
1156*4882a593Smuzhiyun 	/*
1157*4882a593Smuzhiyun 	 * It may turn out to be that the whole @from physical eraseblock
1158*4882a593Smuzhiyun 	 * contains only 0xFF bytes. Then we have to only write the VID header
1159*4882a593Smuzhiyun 	 * and do not write any data. This also means we should not set
1160*4882a593Smuzhiyun 	 * @vid_hdr->copy_flag, @vid_hdr->data_size, and @vid_hdr->data_crc.
1161*4882a593Smuzhiyun 	 */
1162*4882a593Smuzhiyun 	if (data_size > 0) {
1163*4882a593Smuzhiyun 		vid_hdr->copy_flag = 1;
1164*4882a593Smuzhiyun 		vid_hdr->data_size = cpu_to_be32(data_size);
1165*4882a593Smuzhiyun 		vid_hdr->data_crc = cpu_to_be32(crc);
1166*4882a593Smuzhiyun 	}
1167*4882a593Smuzhiyun 	vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1168*4882a593Smuzhiyun 
1169*4882a593Smuzhiyun 	err = ubi_io_write_vid_hdr(ubi, to, vid_hdr);
1170*4882a593Smuzhiyun 	if (err) {
1171*4882a593Smuzhiyun 		if (err == -EIO)
1172*4882a593Smuzhiyun 			err = MOVE_TARGET_WR_ERR;
1173*4882a593Smuzhiyun 		goto out_unlock_buf;
1174*4882a593Smuzhiyun 	}
1175*4882a593Smuzhiyun 
1176*4882a593Smuzhiyun 	cond_resched();
1177*4882a593Smuzhiyun 
1178*4882a593Smuzhiyun 	/* Read the VID header back and check if it was written correctly */
1179*4882a593Smuzhiyun 	err = ubi_io_read_vid_hdr(ubi, to, vid_hdr, 1);
1180*4882a593Smuzhiyun 	if (err) {
1181*4882a593Smuzhiyun 		if (err != UBI_IO_BITFLIPS) {
1182*4882a593Smuzhiyun 			ubi_warn(ubi, "error %d while reading VID header back from PEB %d",
1183*4882a593Smuzhiyun 				 err, to);
1184*4882a593Smuzhiyun 			if (is_error_sane(err))
1185*4882a593Smuzhiyun 				err = MOVE_TARGET_RD_ERR;
1186*4882a593Smuzhiyun 		} else
1187*4882a593Smuzhiyun 			err = MOVE_TARGET_BITFLIPS;
1188*4882a593Smuzhiyun 		goto out_unlock_buf;
1189*4882a593Smuzhiyun 	}
1190*4882a593Smuzhiyun 
1191*4882a593Smuzhiyun 	if (data_size > 0) {
1192*4882a593Smuzhiyun 		err = ubi_io_write_data(ubi, ubi->peb_buf, to, 0, aldata_size);
1193*4882a593Smuzhiyun 		if (err) {
1194*4882a593Smuzhiyun 			if (err == -EIO)
1195*4882a593Smuzhiyun 				err = MOVE_TARGET_WR_ERR;
1196*4882a593Smuzhiyun 			goto out_unlock_buf;
1197*4882a593Smuzhiyun 		}
1198*4882a593Smuzhiyun 
1199*4882a593Smuzhiyun 		cond_resched();
1200*4882a593Smuzhiyun 
1201*4882a593Smuzhiyun 		/*
1202*4882a593Smuzhiyun 		 * We've written the data and are going to read it back to make
1203*4882a593Smuzhiyun 		 * sure it was written correctly.
1204*4882a593Smuzhiyun 		 */
1205*4882a593Smuzhiyun 		memset(ubi->peb_buf, 0xFF, aldata_size);
1206*4882a593Smuzhiyun 		err = ubi_io_read_data(ubi, ubi->peb_buf, to, 0, aldata_size);
1207*4882a593Smuzhiyun 		if (err) {
1208*4882a593Smuzhiyun 			if (err != UBI_IO_BITFLIPS) {
1209*4882a593Smuzhiyun 				ubi_warn(ubi, "error %d while reading data back from PEB %d",
1210*4882a593Smuzhiyun 					 err, to);
1211*4882a593Smuzhiyun 				if (is_error_sane(err))
1212*4882a593Smuzhiyun 					err = MOVE_TARGET_RD_ERR;
1213*4882a593Smuzhiyun 			} else
1214*4882a593Smuzhiyun 				err = MOVE_TARGET_BITFLIPS;
1215*4882a593Smuzhiyun 			goto out_unlock_buf;
1216*4882a593Smuzhiyun 		}
1217*4882a593Smuzhiyun 
1218*4882a593Smuzhiyun 		cond_resched();
1219*4882a593Smuzhiyun 
1220*4882a593Smuzhiyun 		if (crc != crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size)) {
1221*4882a593Smuzhiyun 			ubi_warn(ubi, "read data back from PEB %d and it is different",
1222*4882a593Smuzhiyun 				 to);
1223*4882a593Smuzhiyun 			err = -EINVAL;
1224*4882a593Smuzhiyun 			goto out_unlock_buf;
1225*4882a593Smuzhiyun 		}
1226*4882a593Smuzhiyun 	}
1227*4882a593Smuzhiyun 
1228*4882a593Smuzhiyun 	ubi_assert(vol->eba_tbl[lnum] == from);
1229*4882a593Smuzhiyun 	down_read(&ubi->fm_eba_sem);
1230*4882a593Smuzhiyun 	vol->eba_tbl[lnum] = to;
1231*4882a593Smuzhiyun 	up_read(&ubi->fm_eba_sem);
1232*4882a593Smuzhiyun 
1233*4882a593Smuzhiyun out_unlock_buf:
1234*4882a593Smuzhiyun 	mutex_unlock(&ubi->buf_mutex);
1235*4882a593Smuzhiyun out_unlock_leb:
1236*4882a593Smuzhiyun 	leb_write_unlock(ubi, vol_id, lnum);
1237*4882a593Smuzhiyun 	return err;
1238*4882a593Smuzhiyun }
1239*4882a593Smuzhiyun 
1240*4882a593Smuzhiyun /**
1241*4882a593Smuzhiyun  * print_rsvd_warning - warn about not having enough reserved PEBs.
1242*4882a593Smuzhiyun  * @ubi: UBI device description object
1243*4882a593Smuzhiyun  *
1244*4882a593Smuzhiyun  * This is a helper function for 'ubi_eba_init()' which is called when UBI
1245*4882a593Smuzhiyun  * cannot reserve enough PEBs for bad block handling. This function makes a
1246*4882a593Smuzhiyun  * decision whether we have to print a warning or not. The algorithm is as
1247*4882a593Smuzhiyun  * follows:
1248*4882a593Smuzhiyun  *   o if this is a new UBI image, then just print the warning
1249*4882a593Smuzhiyun  *   o if this is an UBI image which has already been used for some time, print
1250*4882a593Smuzhiyun  *     a warning only if we can reserve less than 10% of the expected amount of
1251*4882a593Smuzhiyun  *     the reserved PEB.
1252*4882a593Smuzhiyun  *
1253*4882a593Smuzhiyun  * The idea is that when UBI is used, PEBs become bad, and the reserved pool
1254*4882a593Smuzhiyun  * of PEBs becomes smaller, which is normal and we do not want to scare users
1255*4882a593Smuzhiyun  * with a warning every time they attach the MTD device. This was an issue
1256*4882a593Smuzhiyun  * reported by real users.
1257*4882a593Smuzhiyun  */
print_rsvd_warning(struct ubi_device * ubi,struct ubi_attach_info * ai)1258*4882a593Smuzhiyun static void print_rsvd_warning(struct ubi_device *ubi,
1259*4882a593Smuzhiyun 			       struct ubi_attach_info *ai)
1260*4882a593Smuzhiyun {
1261*4882a593Smuzhiyun 	/*
1262*4882a593Smuzhiyun 	 * The 1 << 18 (256KiB) number is picked randomly, just a reasonably
1263*4882a593Smuzhiyun 	 * large number to distinguish between newly flashed and used images.
1264*4882a593Smuzhiyun 	 */
1265*4882a593Smuzhiyun 	if (ai->max_sqnum > (1 << 18)) {
1266*4882a593Smuzhiyun 		int min = ubi->beb_rsvd_level / 10;
1267*4882a593Smuzhiyun 
1268*4882a593Smuzhiyun 		if (!min)
1269*4882a593Smuzhiyun 			min = 1;
1270*4882a593Smuzhiyun 		if (ubi->beb_rsvd_pebs > min)
1271*4882a593Smuzhiyun 			return;
1272*4882a593Smuzhiyun 	}
1273*4882a593Smuzhiyun 
1274*4882a593Smuzhiyun 	ubi_warn(ubi, "cannot reserve enough PEBs for bad PEB handling, reserved %d, need %d",
1275*4882a593Smuzhiyun 		 ubi->beb_rsvd_pebs, ubi->beb_rsvd_level);
1276*4882a593Smuzhiyun 	if (ubi->corr_peb_count)
1277*4882a593Smuzhiyun 		ubi_warn(ubi, "%d PEBs are corrupted and not used",
1278*4882a593Smuzhiyun 			 ubi->corr_peb_count);
1279*4882a593Smuzhiyun }
1280*4882a593Smuzhiyun 
1281*4882a593Smuzhiyun /**
1282*4882a593Smuzhiyun  * self_check_eba - run a self check on the EBA table constructed by fastmap.
1283*4882a593Smuzhiyun  * @ubi: UBI device description object
1284*4882a593Smuzhiyun  * @ai_fastmap: UBI attach info object created by fastmap
1285*4882a593Smuzhiyun  * @ai_scan: UBI attach info object created by scanning
1286*4882a593Smuzhiyun  *
1287*4882a593Smuzhiyun  * Returns < 0 in case of an internal error, 0 otherwise.
1288*4882a593Smuzhiyun  * If a bad EBA table entry was found it will be printed out and
1289*4882a593Smuzhiyun  * ubi_assert() triggers.
1290*4882a593Smuzhiyun  */
self_check_eba(struct ubi_device * ubi,struct ubi_attach_info * ai_fastmap,struct ubi_attach_info * ai_scan)1291*4882a593Smuzhiyun int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
1292*4882a593Smuzhiyun 		   struct ubi_attach_info *ai_scan)
1293*4882a593Smuzhiyun {
1294*4882a593Smuzhiyun 	int i, j, num_volumes, ret = 0;
1295*4882a593Smuzhiyun 	int **scan_eba, **fm_eba;
1296*4882a593Smuzhiyun 	struct ubi_ainf_volume *av;
1297*4882a593Smuzhiyun 	struct ubi_volume *vol;
1298*4882a593Smuzhiyun 	struct ubi_ainf_peb *aeb;
1299*4882a593Smuzhiyun 	struct rb_node *rb;
1300*4882a593Smuzhiyun 
1301*4882a593Smuzhiyun 	num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1302*4882a593Smuzhiyun 
1303*4882a593Smuzhiyun 	scan_eba = kmalloc(sizeof(*scan_eba) * num_volumes, GFP_KERNEL);
1304*4882a593Smuzhiyun 	if (!scan_eba)
1305*4882a593Smuzhiyun 		return -ENOMEM;
1306*4882a593Smuzhiyun 
1307*4882a593Smuzhiyun 	fm_eba = kmalloc(sizeof(*fm_eba) * num_volumes, GFP_KERNEL);
1308*4882a593Smuzhiyun 	if (!fm_eba) {
1309*4882a593Smuzhiyun 		kfree(scan_eba);
1310*4882a593Smuzhiyun 		return -ENOMEM;
1311*4882a593Smuzhiyun 	}
1312*4882a593Smuzhiyun 
1313*4882a593Smuzhiyun 	for (i = 0; i < num_volumes; i++) {
1314*4882a593Smuzhiyun 		vol = ubi->volumes[i];
1315*4882a593Smuzhiyun 		if (!vol)
1316*4882a593Smuzhiyun 			continue;
1317*4882a593Smuzhiyun 
1318*4882a593Smuzhiyun 		scan_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**scan_eba),
1319*4882a593Smuzhiyun 				      GFP_KERNEL);
1320*4882a593Smuzhiyun 		if (!scan_eba[i]) {
1321*4882a593Smuzhiyun 			ret = -ENOMEM;
1322*4882a593Smuzhiyun 			goto out_free;
1323*4882a593Smuzhiyun 		}
1324*4882a593Smuzhiyun 
1325*4882a593Smuzhiyun 		fm_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**fm_eba),
1326*4882a593Smuzhiyun 				    GFP_KERNEL);
1327*4882a593Smuzhiyun 		if (!fm_eba[i]) {
1328*4882a593Smuzhiyun 			ret = -ENOMEM;
1329*4882a593Smuzhiyun 			goto out_free;
1330*4882a593Smuzhiyun 		}
1331*4882a593Smuzhiyun 
1332*4882a593Smuzhiyun 		for (j = 0; j < vol->reserved_pebs; j++)
1333*4882a593Smuzhiyun 			scan_eba[i][j] = fm_eba[i][j] = UBI_LEB_UNMAPPED;
1334*4882a593Smuzhiyun 
1335*4882a593Smuzhiyun 		av = ubi_find_av(ai_scan, idx2vol_id(ubi, i));
1336*4882a593Smuzhiyun 		if (!av)
1337*4882a593Smuzhiyun 			continue;
1338*4882a593Smuzhiyun 
1339*4882a593Smuzhiyun 		ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1340*4882a593Smuzhiyun 			scan_eba[i][aeb->lnum] = aeb->pnum;
1341*4882a593Smuzhiyun 
1342*4882a593Smuzhiyun 		av = ubi_find_av(ai_fastmap, idx2vol_id(ubi, i));
1343*4882a593Smuzhiyun 		if (!av)
1344*4882a593Smuzhiyun 			continue;
1345*4882a593Smuzhiyun 
1346*4882a593Smuzhiyun 		ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1347*4882a593Smuzhiyun 			fm_eba[i][aeb->lnum] = aeb->pnum;
1348*4882a593Smuzhiyun 
1349*4882a593Smuzhiyun 		for (j = 0; j < vol->reserved_pebs; j++) {
1350*4882a593Smuzhiyun 			if (scan_eba[i][j] != fm_eba[i][j]) {
1351*4882a593Smuzhiyun 				if (scan_eba[i][j] == UBI_LEB_UNMAPPED ||
1352*4882a593Smuzhiyun 					fm_eba[i][j] == UBI_LEB_UNMAPPED)
1353*4882a593Smuzhiyun 					continue;
1354*4882a593Smuzhiyun 
1355*4882a593Smuzhiyun 				ubi_err(ubi, "LEB:%i:%i is PEB:%i instead of %i!",
1356*4882a593Smuzhiyun 					vol->vol_id, i, fm_eba[i][j],
1357*4882a593Smuzhiyun 					scan_eba[i][j]);
1358*4882a593Smuzhiyun 				ubi_assert(0);
1359*4882a593Smuzhiyun 			}
1360*4882a593Smuzhiyun 		}
1361*4882a593Smuzhiyun 	}
1362*4882a593Smuzhiyun 
1363*4882a593Smuzhiyun out_free:
1364*4882a593Smuzhiyun 	for (i = 0; i < num_volumes; i++) {
1365*4882a593Smuzhiyun 		if (!ubi->volumes[i])
1366*4882a593Smuzhiyun 			continue;
1367*4882a593Smuzhiyun 
1368*4882a593Smuzhiyun 		kfree(scan_eba[i]);
1369*4882a593Smuzhiyun 		kfree(fm_eba[i]);
1370*4882a593Smuzhiyun 	}
1371*4882a593Smuzhiyun 
1372*4882a593Smuzhiyun 	kfree(scan_eba);
1373*4882a593Smuzhiyun 	kfree(fm_eba);
1374*4882a593Smuzhiyun 	return ret;
1375*4882a593Smuzhiyun }
1376*4882a593Smuzhiyun 
1377*4882a593Smuzhiyun /**
1378*4882a593Smuzhiyun  * ubi_eba_init - initialize the EBA sub-system using attaching information.
1379*4882a593Smuzhiyun  * @ubi: UBI device description object
1380*4882a593Smuzhiyun  * @ai: attaching information
1381*4882a593Smuzhiyun  *
1382*4882a593Smuzhiyun  * This function returns zero in case of success and a negative error code in
1383*4882a593Smuzhiyun  * case of failure.
1384*4882a593Smuzhiyun  */
ubi_eba_init(struct ubi_device * ubi,struct ubi_attach_info * ai)1385*4882a593Smuzhiyun int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
1386*4882a593Smuzhiyun {
1387*4882a593Smuzhiyun 	int i, j, err, num_volumes;
1388*4882a593Smuzhiyun 	struct ubi_ainf_volume *av;
1389*4882a593Smuzhiyun 	struct ubi_volume *vol;
1390*4882a593Smuzhiyun 	struct ubi_ainf_peb *aeb;
1391*4882a593Smuzhiyun 	struct rb_node *rb;
1392*4882a593Smuzhiyun 
1393*4882a593Smuzhiyun 	dbg_eba("initialize EBA sub-system");
1394*4882a593Smuzhiyun 
1395*4882a593Smuzhiyun 	spin_lock_init(&ubi->ltree_lock);
1396*4882a593Smuzhiyun 	mutex_init(&ubi->alc_mutex);
1397*4882a593Smuzhiyun 	ubi->ltree = RB_ROOT;
1398*4882a593Smuzhiyun 
1399*4882a593Smuzhiyun 	ubi->global_sqnum = ai->max_sqnum + 1;
1400*4882a593Smuzhiyun 	num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1401*4882a593Smuzhiyun 
1402*4882a593Smuzhiyun 	for (i = 0; i < num_volumes; i++) {
1403*4882a593Smuzhiyun 		vol = ubi->volumes[i];
1404*4882a593Smuzhiyun 		if (!vol)
1405*4882a593Smuzhiyun 			continue;
1406*4882a593Smuzhiyun 
1407*4882a593Smuzhiyun 		cond_resched();
1408*4882a593Smuzhiyun 
1409*4882a593Smuzhiyun 		vol->eba_tbl = kmalloc(vol->reserved_pebs * sizeof(int),
1410*4882a593Smuzhiyun 				       GFP_KERNEL);
1411*4882a593Smuzhiyun 		if (!vol->eba_tbl) {
1412*4882a593Smuzhiyun 			err = -ENOMEM;
1413*4882a593Smuzhiyun 			goto out_free;
1414*4882a593Smuzhiyun 		}
1415*4882a593Smuzhiyun 
1416*4882a593Smuzhiyun 		for (j = 0; j < vol->reserved_pebs; j++)
1417*4882a593Smuzhiyun 			vol->eba_tbl[j] = UBI_LEB_UNMAPPED;
1418*4882a593Smuzhiyun 
1419*4882a593Smuzhiyun 		av = ubi_find_av(ai, idx2vol_id(ubi, i));
1420*4882a593Smuzhiyun 		if (!av)
1421*4882a593Smuzhiyun 			continue;
1422*4882a593Smuzhiyun 
1423*4882a593Smuzhiyun 		ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
1424*4882a593Smuzhiyun 			if (aeb->lnum >= vol->reserved_pebs)
1425*4882a593Smuzhiyun 				/*
1426*4882a593Smuzhiyun 				 * This may happen in case of an unclean reboot
1427*4882a593Smuzhiyun 				 * during re-size.
1428*4882a593Smuzhiyun 				 */
1429*4882a593Smuzhiyun 				ubi_move_aeb_to_list(av, aeb, &ai->erase);
1430*4882a593Smuzhiyun 			else
1431*4882a593Smuzhiyun 				vol->eba_tbl[aeb->lnum] = aeb->pnum;
1432*4882a593Smuzhiyun 		}
1433*4882a593Smuzhiyun 	}
1434*4882a593Smuzhiyun 
1435*4882a593Smuzhiyun 	if (ubi->avail_pebs < EBA_RESERVED_PEBS) {
1436*4882a593Smuzhiyun 		ubi_err(ubi, "no enough physical eraseblocks (%d, need %d)",
1437*4882a593Smuzhiyun 			ubi->avail_pebs, EBA_RESERVED_PEBS);
1438*4882a593Smuzhiyun 		if (ubi->corr_peb_count)
1439*4882a593Smuzhiyun 			ubi_err(ubi, "%d PEBs are corrupted and not used",
1440*4882a593Smuzhiyun 				ubi->corr_peb_count);
1441*4882a593Smuzhiyun 		err = -ENOSPC;
1442*4882a593Smuzhiyun 		goto out_free;
1443*4882a593Smuzhiyun 	}
1444*4882a593Smuzhiyun 	ubi->avail_pebs -= EBA_RESERVED_PEBS;
1445*4882a593Smuzhiyun 	ubi->rsvd_pebs += EBA_RESERVED_PEBS;
1446*4882a593Smuzhiyun 
1447*4882a593Smuzhiyun 	if (ubi->bad_allowed) {
1448*4882a593Smuzhiyun 		ubi_calculate_reserved(ubi);
1449*4882a593Smuzhiyun 
1450*4882a593Smuzhiyun 		if (ubi->avail_pebs < ubi->beb_rsvd_level) {
1451*4882a593Smuzhiyun 			/* No enough free physical eraseblocks */
1452*4882a593Smuzhiyun 			ubi->beb_rsvd_pebs = ubi->avail_pebs;
1453*4882a593Smuzhiyun 			print_rsvd_warning(ubi, ai);
1454*4882a593Smuzhiyun 		} else
1455*4882a593Smuzhiyun 			ubi->beb_rsvd_pebs = ubi->beb_rsvd_level;
1456*4882a593Smuzhiyun 
1457*4882a593Smuzhiyun 		ubi->avail_pebs -= ubi->beb_rsvd_pebs;
1458*4882a593Smuzhiyun 		ubi->rsvd_pebs  += ubi->beb_rsvd_pebs;
1459*4882a593Smuzhiyun 	}
1460*4882a593Smuzhiyun 
1461*4882a593Smuzhiyun 	dbg_eba("EBA sub-system is initialized");
1462*4882a593Smuzhiyun 	return 0;
1463*4882a593Smuzhiyun 
1464*4882a593Smuzhiyun out_free:
1465*4882a593Smuzhiyun 	for (i = 0; i < num_volumes; i++) {
1466*4882a593Smuzhiyun 		if (!ubi->volumes[i])
1467*4882a593Smuzhiyun 			continue;
1468*4882a593Smuzhiyun 		kfree(ubi->volumes[i]->eba_tbl);
1469*4882a593Smuzhiyun 		ubi->volumes[i]->eba_tbl = NULL;
1470*4882a593Smuzhiyun 	}
1471*4882a593Smuzhiyun 	return err;
1472*4882a593Smuzhiyun }
1473