Commit | Line | Data |
---|---|---|
801c135c AB |
1 | /* |
2 | * Copyright (c) International Business Machines Corp., 2006 | |
3 | * Copyright (c) Nokia Corporation, 2006, 2007 | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License as published by | |
7 | * the Free Software Foundation; either version 2 of the License, or | |
8 | * (at your option) any later version. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See | |
13 | * the GNU General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License | |
16 | * along with this program; if not, write to the Free Software | |
17 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
18 | * | |
19 | * Author: Artem Bityutskiy (Битюцкий Артём) | |
20 | */ | |
21 | ||
22 | #ifndef __UBI_UBI_H__ | |
23 | #define __UBI_UBI_H__ | |
24 | ||
25 | #include <linux/init.h> | |
26 | #include <linux/types.h> | |
27 | #include <linux/list.h> | |
28 | #include <linux/rbtree.h> | |
29 | #include <linux/sched.h> | |
30 | #include <linux/wait.h> | |
31 | #include <linux/mutex.h> | |
32 | #include <linux/rwsem.h> | |
33 | #include <linux/spinlock.h> | |
34 | #include <linux/fs.h> | |
35 | #include <linux/cdev.h> | |
36 | #include <linux/device.h> | |
37 | #include <linux/string.h> | |
92ad8f37 | 38 | #include <linux/vmalloc.h> |
801c135c | 39 | #include <linux/mtd/mtd.h> |
801c135c AB |
40 | #include <linux/mtd/ubi.h> |
41 | ||
92a74f1c | 42 | #include "ubi-media.h" |
801c135c AB |
43 | #include "scan.h" |
44 | #include "debug.h" | |
45 | ||
46 | /* Maximum number of supported UBI devices */ | |
47 | #define UBI_MAX_DEVICES 32 | |
48 | ||
49 | /* UBI name used for character devices, sysfs, etc */ | |
50 | #define UBI_NAME_STR "ubi" | |
51 | ||
52 | /* Normal UBI messages */ | |
53 | #define ubi_msg(fmt, ...) printk(KERN_NOTICE "UBI: " fmt "\n", ##__VA_ARGS__) | |
54 | /* UBI warning messages */ | |
55 | #define ubi_warn(fmt, ...) printk(KERN_WARNING "UBI warning: %s: " fmt "\n", \ | |
cb53b3b9 | 56 | __func__, ##__VA_ARGS__) |
801c135c AB |
57 | /* UBI error messages */ |
58 | #define ubi_err(fmt, ...) printk(KERN_ERR "UBI error: %s: " fmt "\n", \ | |
cb53b3b9 | 59 | __func__, ##__VA_ARGS__) |
801c135c AB |
60 | |
61 | /* Lowest number PEBs reserved for bad PEB handling */ | |
62 | #define MIN_RESEVED_PEBS 2 | |
63 | ||
64 | /* Background thread name pattern */ | |
65 | #define UBI_BGT_NAME_PATTERN "ubi_bgt%dd" | |
66 | ||
67 | /* This marker in the EBA table means that the LEB is um-mapped */ | |
68 | #define UBI_LEB_UNMAPPED -1 | |
69 | ||
70 | /* | |
71 | * In case of errors, UBI tries to repeat the operation several times before | |
72 | * returning error. The below constant defines how many times UBI re-tries. | |
73 | */ | |
74 | #define UBI_IO_RETRIES 3 | |
75 | ||
7b6c32da XX |
76 | /* |
77 | * Length of the protection queue. The length is effectively equivalent to the | |
78 | * number of (global) erase cycles PEBs are protected from the wear-leveling | |
79 | * worker. | |
80 | */ | |
81 | #define UBI_PROT_QUEUE_LEN 10 | |
82 | ||
801c135c | 83 | /* |
85c6e6e2 | 84 | * Error codes returned by the I/O sub-system. |
801c135c AB |
85 | * |
86 | * UBI_IO_PEB_EMPTY: the physical eraseblock is empty, i.e. it contains only | |
85c6e6e2 | 87 | * %0xFF bytes |
801c135c | 88 | * UBI_IO_PEB_FREE: the physical eraseblock is free, i.e. it contains only a |
85c6e6e2 | 89 | * valid erase counter header, and the rest are %0xFF bytes |
801c135c AB |
90 | * UBI_IO_BAD_EC_HDR: the erase counter header is corrupted (bad magic or CRC) |
91 | * UBI_IO_BAD_VID_HDR: the volume identifier header is corrupted (bad magic or | |
85c6e6e2 | 92 | * CRC) |
801c135c AB |
93 | * UBI_IO_BITFLIPS: bit-flips were detected and corrected |
94 | */ | |
95 | enum { | |
96 | UBI_IO_PEB_EMPTY = 1, | |
97 | UBI_IO_PEB_FREE, | |
98 | UBI_IO_BAD_EC_HDR, | |
99 | UBI_IO_BAD_VID_HDR, | |
100 | UBI_IO_BITFLIPS | |
101 | }; | |
102 | ||
06b68ba1 AB |
103 | /** |
104 | * struct ubi_wl_entry - wear-leveling entry. | |
23553b2c | 105 | * @u.rb: link in the corresponding (free/used) RB-tree |
7b6c32da | 106 | * @u.list: link in the protection queue |
06b68ba1 AB |
107 | * @ec: erase counter |
108 | * @pnum: physical eraseblock number | |
109 | * | |
85c6e6e2 AB |
110 | * This data structure is used in the WL sub-system. Each physical eraseblock |
111 | * has a corresponding &struct wl_entry object which may be kept in different | |
112 | * RB-trees. See WL sub-system for details. | |
06b68ba1 AB |
113 | */ |
114 | struct ubi_wl_entry { | |
23553b2c XX |
115 | union { |
116 | struct rb_node rb; | |
7b6c32da | 117 | struct list_head list; |
23553b2c | 118 | } u; |
06b68ba1 AB |
119 | int ec; |
120 | int pnum; | |
121 | }; | |
122 | ||
3a8d4642 AB |
123 | /** |
124 | * struct ubi_ltree_entry - an entry in the lock tree. | |
125 | * @rb: links RB-tree nodes | |
126 | * @vol_id: volume ID of the locked logical eraseblock | |
127 | * @lnum: locked logical eraseblock number | |
128 | * @users: how many tasks are using this logical eraseblock or wait for it | |
129 | * @mutex: read/write mutex to implement read/write access serialization to | |
130 | * the (@vol_id, @lnum) logical eraseblock | |
131 | * | |
85c6e6e2 AB |
132 | * This data structure is used in the EBA sub-system to implement per-LEB |
133 | * locking. When a logical eraseblock is being locked - corresponding | |
3a8d4642 | 134 | * &struct ubi_ltree_entry object is inserted to the lock tree (@ubi->ltree). |
85c6e6e2 | 135 | * See EBA sub-system for details. |
3a8d4642 AB |
136 | */ |
137 | struct ubi_ltree_entry { | |
138 | struct rb_node rb; | |
139 | int vol_id; | |
140 | int lnum; | |
141 | int users; | |
142 | struct rw_semaphore mutex; | |
143 | }; | |
144 | ||
f40ac9cd AB |
145 | /** |
146 | * struct ubi_rename_entry - volume re-name description data structure. | |
147 | * @new_name_len: new volume name length | |
148 | * @new_name: new volume name | |
149 | * @remove: if not zero, this volume should be removed, not re-named | |
150 | * @desc: descriptor of the volume | |
151 | * @list: links re-name entries into a list | |
152 | * | |
153 | * This data structure is utilized in the multiple volume re-name code. Namely, | |
154 | * UBI first creates a list of &struct ubi_rename_entry objects from the | |
155 | * &struct ubi_rnvol_req request object, and then utilizes this list to do all | |
156 | * the job. | |
157 | */ | |
158 | struct ubi_rename_entry { | |
159 | int new_name_len; | |
160 | char new_name[UBI_VOL_NAME_MAX + 1]; | |
161 | int remove; | |
162 | struct ubi_volume_desc *desc; | |
163 | struct list_head list; | |
164 | }; | |
165 | ||
801c135c AB |
166 | struct ubi_volume_desc; |
167 | ||
168 | /** | |
169 | * struct ubi_volume - UBI volume description data structure. | |
170 | * @dev: device object to make use of the the Linux device model | |
171 | * @cdev: character device object to create character device | |
172 | * @ubi: reference to the UBI device description object | |
173 | * @vol_id: volume ID | |
d05c77a8 | 174 | * @ref_count: volume reference count |
801c135c AB |
175 | * @readers: number of users holding this volume in read-only mode |
176 | * @writers: number of users holding this volume in read-write mode | |
177 | * @exclusive: whether somebody holds this volume in exclusive mode | |
801c135c AB |
178 | * |
179 | * @reserved_pebs: how many physical eraseblocks are reserved for this volume | |
180 | * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME) | |
181 | * @usable_leb_size: logical eraseblock size without padding | |
182 | * @used_ebs: how many logical eraseblocks in this volume contain data | |
183 | * @last_eb_bytes: how many bytes are stored in the last logical eraseblock | |
184 | * @used_bytes: how many bytes of data this volume contains | |
801c135c AB |
185 | * @alignment: volume alignment |
186 | * @data_pad: how many bytes are not used at the end of physical eraseblocks to | |
d05c77a8 | 187 | * satisfy the requested alignment |
801c135c AB |
188 | * @name_len: volume name length |
189 | * @name: volume name | |
190 | * | |
801c135c | 191 | * @upd_ebs: how many eraseblocks are expected to be updated |
e653879c AB |
192 | * @ch_lnum: LEB number which is being changing by the atomic LEB change |
193 | * operation | |
194 | * @ch_dtype: data persistency type which is being changing by the atomic LEB | |
195 | * change operation | |
196 | * @upd_bytes: how many bytes are expected to be received for volume update or | |
197 | * atomic LEB change | |
198 | * @upd_received: how many bytes were already received for volume update or | |
199 | * atomic LEB change | |
200 | * @upd_buf: update buffer which is used to collect update data or data for | |
201 | * atomic LEB change | |
801c135c AB |
202 | * |
203 | * @eba_tbl: EBA table of this volume (LEB->PEB mapping) | |
896c0c06 AB |
204 | * @checked: %1 if this static volume was checked |
205 | * @corrupted: %1 if the volume is corrupted (static volumes only) | |
206 | * @upd_marker: %1 if the update marker is set for this volume | |
207 | * @updating: %1 if the volume is being updated | |
e653879c | 208 | * @changing_leb: %1 if the atomic LEB change ioctl command is in progress |
766fb95b | 209 | * @direct_writes: %1 if direct writes are enabled for this volume |
801c135c AB |
210 | * |
211 | * @gluebi_desc: gluebi UBI volume descriptor | |
212 | * @gluebi_refcount: reference count of the gluebi MTD device | |
213 | * @gluebi_mtd: MTD device description object of the gluebi MTD device | |
214 | * | |
215 | * The @corrupted field indicates that the volume's contents is corrupted. | |
216 | * Since UBI protects only static volumes, this field is not relevant to | |
217 | * dynamic volumes - it is user's responsibility to assure their data | |
218 | * integrity. | |
219 | * | |
220 | * The @upd_marker flag indicates that this volume is either being updated at | |
221 | * the moment or is damaged because of an unclean reboot. | |
222 | */ | |
223 | struct ubi_volume { | |
224 | struct device dev; | |
225 | struct cdev cdev; | |
226 | struct ubi_device *ubi; | |
227 | int vol_id; | |
d05c77a8 | 228 | int ref_count; |
801c135c AB |
229 | int readers; |
230 | int writers; | |
231 | int exclusive; | |
801c135c AB |
232 | |
233 | int reserved_pebs; | |
234 | int vol_type; | |
235 | int usable_leb_size; | |
236 | int used_ebs; | |
237 | int last_eb_bytes; | |
238 | long long used_bytes; | |
801c135c AB |
239 | int alignment; |
240 | int data_pad; | |
241 | int name_len; | |
f40ac9cd | 242 | char name[UBI_VOL_NAME_MAX + 1]; |
801c135c | 243 | |
801c135c | 244 | int upd_ebs; |
e653879c AB |
245 | int ch_lnum; |
246 | int ch_dtype; | |
801c135c AB |
247 | long long upd_bytes; |
248 | long long upd_received; | |
249 | void *upd_buf; | |
250 | ||
251 | int *eba_tbl; | |
8eee9f10 HH |
252 | unsigned int checked:1; |
253 | unsigned int corrupted:1; | |
254 | unsigned int upd_marker:1; | |
255 | unsigned int updating:1; | |
256 | unsigned int changing_leb:1; | |
766fb95b | 257 | unsigned int direct_writes:1; |
801c135c AB |
258 | |
259 | #ifdef CONFIG_MTD_UBI_GLUEBI | |
e653879c AB |
260 | /* |
261 | * Gluebi-related stuff may be compiled out. | |
85c6e6e2 | 262 | * Note: this should not be built into UBI but should be a separate |
e653879c AB |
263 | * ubimtd driver which works on top of UBI and emulates MTD devices. |
264 | */ | |
801c135c AB |
265 | struct ubi_volume_desc *gluebi_desc; |
266 | int gluebi_refcount; | |
267 | struct mtd_info gluebi_mtd; | |
268 | #endif | |
269 | }; | |
270 | ||
271 | /** | |
85c6e6e2 | 272 | * struct ubi_volume_desc - UBI volume descriptor returned when it is opened. |
801c135c AB |
273 | * @vol: reference to the corresponding volume description object |
274 | * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, or %UBI_EXCLUSIVE) | |
275 | */ | |
276 | struct ubi_volume_desc { | |
277 | struct ubi_volume *vol; | |
278 | int mode; | |
279 | }; | |
280 | ||
281 | struct ubi_wl_entry; | |
282 | ||
283 | /** | |
284 | * struct ubi_device - UBI device description structure | |
9f961b57 | 285 | * @dev: UBI device object to use the the Linux device model |
801c135c AB |
286 | * @cdev: character device object to create character device |
287 | * @ubi_num: UBI device number | |
288 | * @ubi_name: UBI device name | |
801c135c AB |
289 | * @vol_count: number of volumes in this UBI device |
290 | * @volumes: volumes of this UBI device | |
291 | * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs, | |
d05c77a8 AB |
292 | * @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count, |
293 | * @vol->readers, @vol->writers, @vol->exclusive, | |
294 | * @vol->ref_count, @vol->mapping and @vol->eba_tbl. | |
e73f4459 | 295 | * @ref_count: count of references on the UBI device |
801c135c AB |
296 | * |
297 | * @rsvd_pebs: count of reserved physical eraseblocks | |
298 | * @avail_pebs: count of available physical eraseblocks | |
299 | * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB | |
4ccf8cff | 300 | * handling |
801c135c AB |
301 | * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling |
302 | * | |
4ccf8cff | 303 | * @autoresize_vol_id: ID of the volume which has to be auto-resized at the end |
7b6c32da | 304 | * of UBI initialization |
801c135c AB |
305 | * @vtbl_slots: how many slots are available in the volume table |
306 | * @vtbl_size: size of the volume table in bytes | |
307 | * @vtbl: in-RAM volume table copy | |
f089c0b2 AB |
308 | * @device_mutex: protects on-flash volume table and serializes volume |
309 | * creation, deletion, update, re-size, re-name and set | |
310 | * property | |
801c135c AB |
311 | * |
312 | * @max_ec: current highest erase counter value | |
313 | * @mean_ec: current mean erase counter value | |
314 | * | |
e8823bd6 | 315 | * @global_sqnum: global sequence number |
801c135c AB |
316 | * @ltree_lock: protects the lock tree and @global_sqnum |
317 | * @ltree: the lock tree | |
e8823bd6 | 318 | * @alc_mutex: serializes "atomic LEB change" operations |
801c135c AB |
319 | * |
320 | * @used: RB-tree of used physical eraseblocks | |
321 | * @free: RB-tree of free physical eraseblocks | |
322 | * @scrub: RB-tree of physical eraseblocks which need scrubbing | |
7b6c32da XX |
323 | * @pq: protection queue (contain physical eraseblocks which are temporarily |
324 | * protected from the wear-leveling worker) | |
325 | * @pq_head: protection queue head | |
326 | * @wl_lock: protects the @used, @free, @pq, @pq_head, @lookuptbl, @move_from, | |
327 | * @move_to, @move_to_put @erase_pending, @wl_scheduled and @works | |
328 | * fields | |
43f9b25a | 329 | * @move_mutex: serializes eraseblock moves |
7b6c32da | 330 | * @work_sem: synchronizes the WL worker with use tasks |
801c135c AB |
331 | * @wl_scheduled: non-zero if the wear-leveling was scheduled |
332 | * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any | |
d05c77a8 | 333 | * physical eraseblock |
801c135c AB |
334 | * @move_from: physical eraseblock from where the data is being moved |
335 | * @move_to: physical eraseblock where the data is being moved to | |
801c135c AB |
336 | * @move_to_put: if the "to" PEB was put |
337 | * @works: list of pending works | |
338 | * @works_count: count of pending works | |
339 | * @bgt_thread: background thread description object | |
340 | * @thread_enabled: if the background thread is enabled | |
341 | * @bgt_name: background thread name | |
342 | * | |
343 | * @flash_size: underlying MTD device size (in bytes) | |
344 | * @peb_count: count of physical eraseblocks on the MTD device | |
345 | * @peb_size: physical eraseblock size | |
346 | * @bad_peb_count: count of bad physical eraseblocks | |
347 | * @good_peb_count: count of good physical eraseblocks | |
348 | * @min_io_size: minimal input/output unit size of the underlying MTD device | |
349 | * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers | |
350 | * @ro_mode: if the UBI device is in read-only mode | |
351 | * @leb_size: logical eraseblock size | |
352 | * @leb_start: starting offset of logical eraseblocks within physical | |
85c6e6e2 | 353 | * eraseblocks |
801c135c AB |
354 | * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size |
355 | * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size | |
356 | * @vid_hdr_offset: starting offset of the volume identifier header (might be | |
85c6e6e2 | 357 | * unaligned) |
801c135c AB |
358 | * @vid_hdr_aloffset: starting offset of the VID header aligned to |
359 | * @hdrs_min_io_size | |
360 | * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset | |
361 | * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or | |
d05c77a8 | 362 | * not |
801c135c | 363 | * @mtd: MTD device descriptor |
e88d6e10 AB |
364 | * |
365 | * @peb_buf1: a buffer of PEB size used for different purposes | |
366 | * @peb_buf2: another buffer of PEB size used for different purposes | |
7b6c32da | 367 | * @buf_mutex: protects @peb_buf1 and @peb_buf2 |
f40ac9cd | 368 | * @ckvol_mutex: serializes static volume checking when opening |
d05c77a8 | 369 | * @dbg_peb_buf: buffer of PEB size used for debugging |
7b6c32da | 370 | * @dbg_buf_mutex: protects @dbg_peb_buf |
801c135c AB |
371 | */ |
372 | struct ubi_device { | |
373 | struct cdev cdev; | |
374 | struct device dev; | |
375 | int ubi_num; | |
376 | char ubi_name[sizeof(UBI_NAME_STR)+5]; | |
801c135c AB |
377 | int vol_count; |
378 | struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT]; | |
379 | spinlock_t volumes_lock; | |
e73f4459 | 380 | int ref_count; |
801c135c AB |
381 | |
382 | int rsvd_pebs; | |
383 | int avail_pebs; | |
384 | int beb_rsvd_pebs; | |
385 | int beb_rsvd_level; | |
386 | ||
4ccf8cff | 387 | int autoresize_vol_id; |
801c135c AB |
388 | int vtbl_slots; |
389 | int vtbl_size; | |
390 | struct ubi_vtbl_record *vtbl; | |
f089c0b2 | 391 | struct mutex device_mutex; |
801c135c AB |
392 | |
393 | int max_ec; | |
85c6e6e2 | 394 | /* Note, mean_ec is not updated run-time - should be fixed */ |
801c135c AB |
395 | int mean_ec; |
396 | ||
85c6e6e2 | 397 | /* EBA sub-system's stuff */ |
801c135c AB |
398 | unsigned long long global_sqnum; |
399 | spinlock_t ltree_lock; | |
400 | struct rb_root ltree; | |
e8823bd6 | 401 | struct mutex alc_mutex; |
801c135c | 402 | |
85c6e6e2 | 403 | /* Wear-leveling sub-system's stuff */ |
801c135c AB |
404 | struct rb_root used; |
405 | struct rb_root free; | |
406 | struct rb_root scrub; | |
7b6c32da XX |
407 | struct list_head pq[UBI_PROT_QUEUE_LEN]; |
408 | int pq_head; | |
801c135c | 409 | spinlock_t wl_lock; |
43f9b25a | 410 | struct mutex move_mutex; |
593dd33c | 411 | struct rw_semaphore work_sem; |
801c135c AB |
412 | int wl_scheduled; |
413 | struct ubi_wl_entry **lookuptbl; | |
801c135c AB |
414 | struct ubi_wl_entry *move_from; |
415 | struct ubi_wl_entry *move_to; | |
801c135c AB |
416 | int move_to_put; |
417 | struct list_head works; | |
418 | int works_count; | |
419 | struct task_struct *bgt_thread; | |
420 | int thread_enabled; | |
421 | char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2]; | |
422 | ||
85c6e6e2 | 423 | /* I/O sub-system's stuff */ |
801c135c AB |
424 | long long flash_size; |
425 | int peb_count; | |
426 | int peb_size; | |
427 | int bad_peb_count; | |
428 | int good_peb_count; | |
429 | int min_io_size; | |
430 | int hdrs_min_io_size; | |
431 | int ro_mode; | |
432 | int leb_size; | |
433 | int leb_start; | |
434 | int ec_hdr_alsize; | |
435 | int vid_hdr_alsize; | |
436 | int vid_hdr_offset; | |
437 | int vid_hdr_aloffset; | |
438 | int vid_hdr_shift; | |
439 | int bad_allowed; | |
440 | struct mtd_info *mtd; | |
e88d6e10 AB |
441 | |
442 | void *peb_buf1; | |
443 | void *peb_buf2; | |
444 | struct mutex buf_mutex; | |
783b273a | 445 | struct mutex ckvol_mutex; |
2cb81e21 | 446 | #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID |
e88d6e10 AB |
447 | void *dbg_peb_buf; |
448 | struct mutex dbg_buf_mutex; | |
449 | #endif | |
801c135c AB |
450 | }; |
451 | ||
06b68ba1 | 452 | extern struct kmem_cache *ubi_wl_entry_slab; |
4d187a88 JE |
453 | extern const struct file_operations ubi_ctrl_cdev_operations; |
454 | extern const struct file_operations ubi_cdev_operations; | |
455 | extern const struct file_operations ubi_vol_cdev_operations; | |
801c135c | 456 | extern struct class *ubi_class; |
cdfa788a | 457 | extern struct mutex ubi_devices_mutex; |
801c135c AB |
458 | |
459 | /* vtbl.c */ | |
460 | int ubi_change_vtbl_record(struct ubi_device *ubi, int idx, | |
461 | struct ubi_vtbl_record *vtbl_rec); | |
f40ac9cd AB |
462 | int ubi_vtbl_rename_volumes(struct ubi_device *ubi, |
463 | struct list_head *rename_list); | |
801c135c AB |
464 | int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_scan_info *si); |
465 | ||
466 | /* vmt.c */ | |
467 | int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req); | |
f40ac9cd | 468 | int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl); |
801c135c | 469 | int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs); |
f40ac9cd | 470 | int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list); |
89b96b69 AB |
471 | int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol); |
472 | void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol); | |
801c135c AB |
473 | |
474 | /* upd.c */ | |
1b68d0ee AB |
475 | int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol, |
476 | long long bytes); | |
477 | int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol, | |
801c135c | 478 | const void __user *buf, int count); |
e653879c AB |
479 | int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol, |
480 | const struct ubi_leb_change_req *req); | |
481 | int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol, | |
482 | const void __user *buf, int count); | |
801c135c AB |
483 | |
484 | /* misc.c */ | |
9c9ec147 AB |
485 | int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf, |
486 | int length); | |
801c135c AB |
487 | int ubi_check_volume(struct ubi_device *ubi, int vol_id); |
488 | void ubi_calculate_reserved(struct ubi_device *ubi); | |
489 | ||
490 | /* gluebi.c */ | |
491 | #ifdef CONFIG_MTD_UBI_GLUEBI | |
492 | int ubi_create_gluebi(struct ubi_device *ubi, struct ubi_volume *vol); | |
493 | int ubi_destroy_gluebi(struct ubi_volume *vol); | |
941dfb07 | 494 | void ubi_gluebi_updated(struct ubi_volume *vol); |
801c135c AB |
495 | #else |
496 | #define ubi_create_gluebi(ubi, vol) 0 | |
497 | #define ubi_destroy_gluebi(vol) 0 | |
941dfb07 | 498 | #define ubi_gluebi_updated(vol) |
801c135c AB |
499 | #endif |
500 | ||
501 | /* eba.c */ | |
89b96b69 AB |
502 | int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol, |
503 | int lnum); | |
504 | int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum, | |
505 | void *buf, int offset, int len, int check); | |
506 | int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum, | |
801c135c | 507 | const void *buf, int offset, int len, int dtype); |
89b96b69 AB |
508 | int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol, |
509 | int lnum, const void *buf, int len, int dtype, | |
801c135c | 510 | int used_ebs); |
89b96b69 AB |
511 | int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol, |
512 | int lnum, const void *buf, int len, int dtype); | |
801c135c AB |
513 | int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to, |
514 | struct ubi_vid_hdr *vid_hdr); | |
515 | int ubi_eba_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si); | |
801c135c AB |
516 | |
517 | /* wl.c */ | |
518 | int ubi_wl_get_peb(struct ubi_device *ubi, int dtype); | |
519 | int ubi_wl_put_peb(struct ubi_device *ubi, int pnum, int torture); | |
520 | int ubi_wl_flush(struct ubi_device *ubi); | |
521 | int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum); | |
522 | int ubi_wl_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si); | |
523 | void ubi_wl_close(struct ubi_device *ubi); | |
cdfa788a | 524 | int ubi_thread(void *u); |
801c135c AB |
525 | |
526 | /* io.c */ | |
527 | int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset, | |
528 | int len); | |
e88d6e10 AB |
529 | int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset, |
530 | int len); | |
531 | int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture); | |
801c135c AB |
532 | int ubi_io_is_bad(const struct ubi_device *ubi, int pnum); |
533 | int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum); | |
e88d6e10 | 534 | int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum, |
801c135c | 535 | struct ubi_ec_hdr *ec_hdr, int verbose); |
e88d6e10 | 536 | int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum, |
801c135c | 537 | struct ubi_ec_hdr *ec_hdr); |
e88d6e10 | 538 | int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum, |
801c135c | 539 | struct ubi_vid_hdr *vid_hdr, int verbose); |
e88d6e10 | 540 | int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum, |
801c135c AB |
541 | struct ubi_vid_hdr *vid_hdr); |
542 | ||
e73f4459 | 543 | /* build.c */ |
897a316c | 544 | int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset); |
cdfa788a | 545 | int ubi_detach_mtd_dev(int ubi_num, int anyway); |
e73f4459 AB |
546 | struct ubi_device *ubi_get_device(int ubi_num); |
547 | void ubi_put_device(struct ubi_device *ubi); | |
548 | struct ubi_device *ubi_get_by_major(int major); | |
549 | int ubi_major2num(int major); | |
550 | ||
801c135c AB |
551 | /* |
552 | * ubi_rb_for_each_entry - walk an RB-tree. | |
553 | * @rb: a pointer to type 'struct rb_node' to to use as a loop counter | |
554 | * @pos: a pointer to RB-tree entry type to use as a loop counter | |
555 | * @root: RB-tree's root | |
556 | * @member: the name of the 'struct rb_node' within the RB-tree entry | |
557 | */ | |
558 | #define ubi_rb_for_each_entry(rb, pos, root, member) \ | |
559 | for (rb = rb_first(root), \ | |
560 | pos = (rb ? container_of(rb, typeof(*pos), member) : NULL); \ | |
561 | rb; \ | |
562 | rb = rb_next(rb), pos = container_of(rb, typeof(*pos), member)) | |
563 | ||
564 | /** | |
565 | * ubi_zalloc_vid_hdr - allocate a volume identifier header object. | |
566 | * @ubi: UBI device description object | |
33818bbb | 567 | * @gfp_flags: GFP flags to allocate with |
801c135c AB |
568 | * |
569 | * This function returns a pointer to the newly allocated and zero-filled | |
570 | * volume identifier header object in case of success and %NULL in case of | |
571 | * failure. | |
572 | */ | |
33818bbb AB |
573 | static inline struct ubi_vid_hdr * |
574 | ubi_zalloc_vid_hdr(const struct ubi_device *ubi, gfp_t gfp_flags) | |
801c135c AB |
575 | { |
576 | void *vid_hdr; | |
577 | ||
33818bbb | 578 | vid_hdr = kzalloc(ubi->vid_hdr_alsize, gfp_flags); |
801c135c AB |
579 | if (!vid_hdr) |
580 | return NULL; | |
581 | ||
582 | /* | |
583 | * VID headers may be stored at un-aligned flash offsets, so we shift | |
584 | * the pointer. | |
585 | */ | |
586 | return vid_hdr + ubi->vid_hdr_shift; | |
587 | } | |
588 | ||
589 | /** | |
590 | * ubi_free_vid_hdr - free a volume identifier header object. | |
591 | * @ubi: UBI device description object | |
592 | * @vid_hdr: the object to free | |
593 | */ | |
594 | static inline void ubi_free_vid_hdr(const struct ubi_device *ubi, | |
595 | struct ubi_vid_hdr *vid_hdr) | |
596 | { | |
597 | void *p = vid_hdr; | |
598 | ||
599 | if (!p) | |
600 | return; | |
601 | ||
602 | kfree(p - ubi->vid_hdr_shift); | |
603 | } | |
604 | ||
605 | /* | |
606 | * This function is equivalent to 'ubi_io_read()', but @offset is relative to | |
607 | * the beginning of the logical eraseblock, not to the beginning of the | |
608 | * physical eraseblock. | |
609 | */ | |
610 | static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf, | |
611 | int pnum, int offset, int len) | |
612 | { | |
613 | ubi_assert(offset >= 0); | |
614 | return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len); | |
615 | } | |
616 | ||
617 | /* | |
618 | * This function is equivalent to 'ubi_io_write()', but @offset is relative to | |
619 | * the beginning of the logical eraseblock, not to the beginning of the | |
620 | * physical eraseblock. | |
621 | */ | |
e88d6e10 | 622 | static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf, |
801c135c AB |
623 | int pnum, int offset, int len) |
624 | { | |
625 | ubi_assert(offset >= 0); | |
626 | return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len); | |
627 | } | |
628 | ||
629 | /** | |
630 | * ubi_ro_mode - switch to read-only mode. | |
631 | * @ubi: UBI device description object | |
632 | */ | |
633 | static inline void ubi_ro_mode(struct ubi_device *ubi) | |
634 | { | |
43f9b25a AB |
635 | if (!ubi->ro_mode) { |
636 | ubi->ro_mode = 1; | |
637 | ubi_warn("switch to read-only mode"); | |
638 | } | |
801c135c AB |
639 | } |
640 | ||
641 | /** | |
642 | * vol_id2idx - get table index by volume ID. | |
643 | * @ubi: UBI device description object | |
644 | * @vol_id: volume ID | |
645 | */ | |
646 | static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id) | |
647 | { | |
648 | if (vol_id >= UBI_INTERNAL_VOL_START) | |
649 | return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots; | |
650 | else | |
651 | return vol_id; | |
652 | } | |
653 | ||
654 | /** | |
655 | * idx2vol_id - get volume ID by table index. | |
656 | * @ubi: UBI device description object | |
657 | * @idx: table index | |
658 | */ | |
659 | static inline int idx2vol_id(const struct ubi_device *ubi, int idx) | |
660 | { | |
661 | if (idx >= ubi->vtbl_slots) | |
662 | return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START; | |
663 | else | |
664 | return idx; | |
665 | } | |
666 | ||
667 | #endif /* !__UBI_UBI_H__ */ |