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