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 AB |
39 | #include <linux/mtd/mtd.h> |
40 | ||
41 | #include <mtd/ubi-header.h> | |
42 | #include <linux/mtd/ubi.h> | |
43 | ||
44 | #include "scan.h" | |
45 | #include "debug.h" | |
46 | ||
47 | /* Maximum number of supported UBI devices */ | |
48 | #define UBI_MAX_DEVICES 32 | |
49 | ||
50 | /* UBI name used for character devices, sysfs, etc */ | |
51 | #define UBI_NAME_STR "ubi" | |
52 | ||
53 | /* Normal UBI messages */ | |
54 | #define ubi_msg(fmt, ...) printk(KERN_NOTICE "UBI: " fmt "\n", ##__VA_ARGS__) | |
55 | /* UBI warning messages */ | |
56 | #define ubi_warn(fmt, ...) printk(KERN_WARNING "UBI warning: %s: " fmt "\n", \ | |
57 | __FUNCTION__, ##__VA_ARGS__) | |
58 | /* UBI error messages */ | |
59 | #define ubi_err(fmt, ...) printk(KERN_ERR "UBI error: %s: " fmt "\n", \ | |
60 | __FUNCTION__, ##__VA_ARGS__) | |
61 | ||
62 | /* Lowest number PEBs reserved for bad PEB handling */ | |
63 | #define MIN_RESEVED_PEBS 2 | |
64 | ||
65 | /* Background thread name pattern */ | |
66 | #define UBI_BGT_NAME_PATTERN "ubi_bgt%dd" | |
67 | ||
68 | /* This marker in the EBA table means that the LEB is um-mapped */ | |
69 | #define UBI_LEB_UNMAPPED -1 | |
70 | ||
71 | /* | |
72 | * In case of errors, UBI tries to repeat the operation several times before | |
73 | * returning error. The below constant defines how many times UBI re-tries. | |
74 | */ | |
75 | #define UBI_IO_RETRIES 3 | |
76 | ||
77 | /* | |
78 | * Error codes returned by the I/O unit. | |
79 | * | |
80 | * UBI_IO_PEB_EMPTY: the physical eraseblock is empty, i.e. it contains only | |
81 | * 0xFF bytes | |
82 | * UBI_IO_PEB_FREE: the physical eraseblock is free, i.e. it contains only a | |
83 | * valid erase counter header, and the rest are %0xFF bytes | |
84 | * UBI_IO_BAD_EC_HDR: the erase counter header is corrupted (bad magic or CRC) | |
85 | * UBI_IO_BAD_VID_HDR: the volume identifier header is corrupted (bad magic or | |
86 | * CRC) | |
87 | * UBI_IO_BITFLIPS: bit-flips were detected and corrected | |
88 | */ | |
89 | enum { | |
90 | UBI_IO_PEB_EMPTY = 1, | |
91 | UBI_IO_PEB_FREE, | |
92 | UBI_IO_BAD_EC_HDR, | |
93 | UBI_IO_BAD_VID_HDR, | |
94 | UBI_IO_BITFLIPS | |
95 | }; | |
96 | ||
97 | extern int ubi_devices_cnt; | |
98 | extern struct ubi_device *ubi_devices[]; | |
99 | ||
100 | struct ubi_volume_desc; | |
101 | ||
102 | /** | |
103 | * struct ubi_volume - UBI volume description data structure. | |
104 | * @dev: device object to make use of the the Linux device model | |
105 | * @cdev: character device object to create character device | |
106 | * @ubi: reference to the UBI device description object | |
107 | * @vol_id: volume ID | |
108 | * @readers: number of users holding this volume in read-only mode | |
109 | * @writers: number of users holding this volume in read-write mode | |
110 | * @exclusive: whether somebody holds this volume in exclusive mode | |
111 | * @removed: if the volume was removed | |
112 | * @checked: if this static volume was checked | |
113 | * | |
114 | * @reserved_pebs: how many physical eraseblocks are reserved for this volume | |
115 | * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME) | |
116 | * @usable_leb_size: logical eraseblock size without padding | |
117 | * @used_ebs: how many logical eraseblocks in this volume contain data | |
118 | * @last_eb_bytes: how many bytes are stored in the last logical eraseblock | |
119 | * @used_bytes: how many bytes of data this volume contains | |
120 | * @upd_marker: non-zero if the update marker is set for this volume | |
121 | * @corrupted: non-zero if the volume is corrupted (static volumes only) | |
122 | * @alignment: volume alignment | |
123 | * @data_pad: how many bytes are not used at the end of physical eraseblocks to | |
124 | * satisfy the requested alignment | |
125 | * @name_len: volume name length | |
126 | * @name: volume name | |
127 | * | |
128 | * @updating: whether the volume is being updated | |
129 | * @upd_ebs: how many eraseblocks are expected to be updated | |
130 | * @upd_bytes: how many bytes are expected to be received | |
131 | * @upd_received: how many update bytes were already received | |
132 | * @upd_buf: update buffer which is used to collect update data | |
133 | * | |
134 | * @eba_tbl: EBA table of this volume (LEB->PEB mapping) | |
135 | * | |
136 | * @gluebi_desc: gluebi UBI volume descriptor | |
137 | * @gluebi_refcount: reference count of the gluebi MTD device | |
138 | * @gluebi_mtd: MTD device description object of the gluebi MTD device | |
139 | * | |
140 | * The @corrupted field indicates that the volume's contents is corrupted. | |
141 | * Since UBI protects only static volumes, this field is not relevant to | |
142 | * dynamic volumes - it is user's responsibility to assure their data | |
143 | * integrity. | |
144 | * | |
145 | * The @upd_marker flag indicates that this volume is either being updated at | |
146 | * the moment or is damaged because of an unclean reboot. | |
147 | */ | |
148 | struct ubi_volume { | |
149 | struct device dev; | |
150 | struct cdev cdev; | |
151 | struct ubi_device *ubi; | |
152 | int vol_id; | |
153 | int readers; | |
154 | int writers; | |
155 | int exclusive; | |
156 | int removed; | |
157 | int checked; | |
158 | ||
159 | int reserved_pebs; | |
160 | int vol_type; | |
161 | int usable_leb_size; | |
162 | int used_ebs; | |
163 | int last_eb_bytes; | |
164 | long long used_bytes; | |
165 | int upd_marker; | |
166 | int corrupted; | |
167 | int alignment; | |
168 | int data_pad; | |
169 | int name_len; | |
170 | char name[UBI_VOL_NAME_MAX+1]; | |
171 | ||
172 | int updating; | |
173 | int upd_ebs; | |
174 | long long upd_bytes; | |
175 | long long upd_received; | |
176 | void *upd_buf; | |
177 | ||
178 | int *eba_tbl; | |
179 | ||
180 | #ifdef CONFIG_MTD_UBI_GLUEBI | |
181 | /* Gluebi-related stuff may be compiled out */ | |
182 | struct ubi_volume_desc *gluebi_desc; | |
183 | int gluebi_refcount; | |
184 | struct mtd_info gluebi_mtd; | |
185 | #endif | |
186 | }; | |
187 | ||
188 | /** | |
189 | * struct ubi_volume_desc - descriptor of the UBI volume returned when it is | |
190 | * opened. | |
191 | * @vol: reference to the corresponding volume description object | |
192 | * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, or %UBI_EXCLUSIVE) | |
193 | */ | |
194 | struct ubi_volume_desc { | |
195 | struct ubi_volume *vol; | |
196 | int mode; | |
197 | }; | |
198 | ||
199 | struct ubi_wl_entry; | |
200 | ||
201 | /** | |
202 | * struct ubi_device - UBI device description structure | |
203 | * @dev: class device object to use the the Linux device model | |
204 | * @cdev: character device object to create character device | |
205 | * @ubi_num: UBI device number | |
206 | * @ubi_name: UBI device name | |
207 | * @major: character device major number | |
208 | * @vol_count: number of volumes in this UBI device | |
209 | * @volumes: volumes of this UBI device | |
210 | * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs, | |
211 | * @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count, @vol->readers, | |
212 | * @vol->writers, @vol->exclusive, @vol->removed, @vol->mapping and | |
213 | * @vol->eba_tbl. | |
214 | * | |
215 | * @rsvd_pebs: count of reserved physical eraseblocks | |
216 | * @avail_pebs: count of available physical eraseblocks | |
217 | * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB | |
218 | * handling | |
219 | * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling | |
220 | * | |
221 | * @vtbl_slots: how many slots are available in the volume table | |
222 | * @vtbl_size: size of the volume table in bytes | |
223 | * @vtbl: in-RAM volume table copy | |
224 | * | |
225 | * @max_ec: current highest erase counter value | |
226 | * @mean_ec: current mean erase counter value | |
227 | * | |
228 | * global_sqnum: global sequence number | |
229 | * @ltree_lock: protects the lock tree and @global_sqnum | |
230 | * @ltree: the lock tree | |
231 | * @vtbl_mutex: protects on-flash volume table | |
232 | * | |
233 | * @used: RB-tree of used physical eraseblocks | |
234 | * @free: RB-tree of free physical eraseblocks | |
235 | * @scrub: RB-tree of physical eraseblocks which need scrubbing | |
236 | * @prot: protection trees | |
237 | * @prot.pnum: protection tree indexed by physical eraseblock numbers | |
238 | * @prot.aec: protection tree indexed by absolute erase counter value | |
239 | * @wl_lock: protects the @used, @free, @prot, @lookuptbl, @abs_ec, @move_from, | |
240 | * @move_to, @move_to_put @erase_pending, @wl_scheduled, and @works | |
241 | * fields | |
242 | * @wl_scheduled: non-zero if the wear-leveling was scheduled | |
243 | * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any | |
244 | * physical eraseblock | |
245 | * @abs_ec: absolute erase counter | |
246 | * @move_from: physical eraseblock from where the data is being moved | |
247 | * @move_to: physical eraseblock where the data is being moved to | |
248 | * @move_from_put: if the "from" PEB was put | |
249 | * @move_to_put: if the "to" PEB was put | |
250 | * @works: list of pending works | |
251 | * @works_count: count of pending works | |
252 | * @bgt_thread: background thread description object | |
253 | * @thread_enabled: if the background thread is enabled | |
254 | * @bgt_name: background thread name | |
255 | * | |
256 | * @flash_size: underlying MTD device size (in bytes) | |
257 | * @peb_count: count of physical eraseblocks on the MTD device | |
258 | * @peb_size: physical eraseblock size | |
259 | * @bad_peb_count: count of bad physical eraseblocks | |
260 | * @good_peb_count: count of good physical eraseblocks | |
261 | * @min_io_size: minimal input/output unit size of the underlying MTD device | |
262 | * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers | |
263 | * @ro_mode: if the UBI device is in read-only mode | |
264 | * @leb_size: logical eraseblock size | |
265 | * @leb_start: starting offset of logical eraseblocks within physical | |
266 | * eraseblocks | |
267 | * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size | |
268 | * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size | |
269 | * @vid_hdr_offset: starting offset of the volume identifier header (might be | |
270 | * unaligned) | |
271 | * @vid_hdr_aloffset: starting offset of the VID header aligned to | |
272 | * @hdrs_min_io_size | |
273 | * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset | |
274 | * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or | |
275 | * not | |
276 | * @mtd: MTD device descriptor | |
e88d6e10 AB |
277 | * |
278 | * @peb_buf1: a buffer of PEB size used for different purposes | |
279 | * @peb_buf2: another buffer of PEB size used for different purposes | |
280 | * @buf_mutex: proptects @peb_buf1 and @peb_buf2 | |
281 | * @dbg_peb_buf: buffer of PEB size used for debugging | |
282 | * @dbg_buf_mutex: proptects @dbg_peb_buf | |
801c135c AB |
283 | */ |
284 | struct ubi_device { | |
285 | struct cdev cdev; | |
286 | struct device dev; | |
287 | int ubi_num; | |
288 | char ubi_name[sizeof(UBI_NAME_STR)+5]; | |
289 | int major; | |
290 | int vol_count; | |
291 | struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT]; | |
292 | spinlock_t volumes_lock; | |
293 | ||
294 | int rsvd_pebs; | |
295 | int avail_pebs; | |
296 | int beb_rsvd_pebs; | |
297 | int beb_rsvd_level; | |
298 | ||
299 | int vtbl_slots; | |
300 | int vtbl_size; | |
301 | struct ubi_vtbl_record *vtbl; | |
302 | struct mutex vtbl_mutex; | |
303 | ||
304 | int max_ec; | |
305 | int mean_ec; | |
306 | ||
307 | /* EBA unit's stuff */ | |
308 | unsigned long long global_sqnum; | |
309 | spinlock_t ltree_lock; | |
310 | struct rb_root ltree; | |
311 | ||
312 | /* Wear-leveling unit's stuff */ | |
313 | struct rb_root used; | |
314 | struct rb_root free; | |
315 | struct rb_root scrub; | |
316 | struct { | |
317 | struct rb_root pnum; | |
318 | struct rb_root aec; | |
319 | } prot; | |
320 | spinlock_t wl_lock; | |
321 | int wl_scheduled; | |
322 | struct ubi_wl_entry **lookuptbl; | |
323 | unsigned long long abs_ec; | |
324 | struct ubi_wl_entry *move_from; | |
325 | struct ubi_wl_entry *move_to; | |
326 | int move_from_put; | |
327 | int move_to_put; | |
328 | struct list_head works; | |
329 | int works_count; | |
330 | struct task_struct *bgt_thread; | |
331 | int thread_enabled; | |
332 | char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2]; | |
333 | ||
334 | /* I/O unit's stuff */ | |
335 | long long flash_size; | |
336 | int peb_count; | |
337 | int peb_size; | |
338 | int bad_peb_count; | |
339 | int good_peb_count; | |
340 | int min_io_size; | |
341 | int hdrs_min_io_size; | |
342 | int ro_mode; | |
343 | int leb_size; | |
344 | int leb_start; | |
345 | int ec_hdr_alsize; | |
346 | int vid_hdr_alsize; | |
347 | int vid_hdr_offset; | |
348 | int vid_hdr_aloffset; | |
349 | int vid_hdr_shift; | |
350 | int bad_allowed; | |
351 | struct mtd_info *mtd; | |
e88d6e10 AB |
352 | |
353 | void *peb_buf1; | |
354 | void *peb_buf2; | |
355 | struct mutex buf_mutex; | |
356 | #ifdef CONFIG_MTD_UBI_DEBUG | |
357 | void *dbg_peb_buf; | |
358 | struct mutex dbg_buf_mutex; | |
359 | #endif | |
801c135c AB |
360 | }; |
361 | ||
362 | extern struct file_operations ubi_cdev_operations; | |
363 | extern struct file_operations ubi_vol_cdev_operations; | |
364 | extern struct class *ubi_class; | |
365 | ||
366 | /* vtbl.c */ | |
367 | int ubi_change_vtbl_record(struct ubi_device *ubi, int idx, | |
368 | struct ubi_vtbl_record *vtbl_rec); | |
369 | int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_scan_info *si); | |
370 | ||
371 | /* vmt.c */ | |
372 | int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req); | |
373 | int ubi_remove_volume(struct ubi_volume_desc *desc); | |
374 | int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs); | |
375 | int ubi_add_volume(struct ubi_device *ubi, int vol_id); | |
376 | void ubi_free_volume(struct ubi_device *ubi, int vol_id); | |
377 | ||
378 | /* upd.c */ | |
379 | int ubi_start_update(struct ubi_device *ubi, int vol_id, long long bytes); | |
380 | int ubi_more_update_data(struct ubi_device *ubi, int vol_id, | |
381 | const void __user *buf, int count); | |
382 | ||
383 | /* misc.c */ | |
384 | int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf, int length); | |
385 | int ubi_check_volume(struct ubi_device *ubi, int vol_id); | |
386 | void ubi_calculate_reserved(struct ubi_device *ubi); | |
387 | ||
388 | /* gluebi.c */ | |
389 | #ifdef CONFIG_MTD_UBI_GLUEBI | |
390 | int ubi_create_gluebi(struct ubi_device *ubi, struct ubi_volume *vol); | |
391 | int ubi_destroy_gluebi(struct ubi_volume *vol); | |
941dfb07 | 392 | void ubi_gluebi_updated(struct ubi_volume *vol); |
801c135c AB |
393 | #else |
394 | #define ubi_create_gluebi(ubi, vol) 0 | |
395 | #define ubi_destroy_gluebi(vol) 0 | |
941dfb07 | 396 | #define ubi_gluebi_updated(vol) |
801c135c AB |
397 | #endif |
398 | ||
399 | /* eba.c */ | |
400 | int ubi_eba_unmap_leb(struct ubi_device *ubi, int vol_id, int lnum); | |
401 | int ubi_eba_read_leb(struct ubi_device *ubi, int vol_id, int lnum, void *buf, | |
402 | int offset, int len, int check); | |
403 | int ubi_eba_write_leb(struct ubi_device *ubi, int vol_id, int lnum, | |
404 | const void *buf, int offset, int len, int dtype); | |
405 | int ubi_eba_write_leb_st(struct ubi_device *ubi, int vol_id, int lnum, | |
406 | const void *buf, int len, int dtype, | |
407 | int used_ebs); | |
408 | int ubi_eba_atomic_leb_change(struct ubi_device *ubi, int vol_id, int lnum, | |
409 | const void *buf, int len, int dtype); | |
410 | int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to, | |
411 | struct ubi_vid_hdr *vid_hdr); | |
412 | int ubi_eba_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si); | |
413 | void ubi_eba_close(const struct ubi_device *ubi); | |
414 | ||
415 | /* wl.c */ | |
416 | int ubi_wl_get_peb(struct ubi_device *ubi, int dtype); | |
417 | int ubi_wl_put_peb(struct ubi_device *ubi, int pnum, int torture); | |
418 | int ubi_wl_flush(struct ubi_device *ubi); | |
419 | int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum); | |
420 | int ubi_wl_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si); | |
421 | void ubi_wl_close(struct ubi_device *ubi); | |
422 | ||
423 | /* io.c */ | |
424 | int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset, | |
425 | int len); | |
e88d6e10 AB |
426 | int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset, |
427 | int len); | |
428 | int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture); | |
801c135c AB |
429 | int ubi_io_is_bad(const struct ubi_device *ubi, int pnum); |
430 | int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum); | |
e88d6e10 | 431 | int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum, |
801c135c | 432 | struct ubi_ec_hdr *ec_hdr, int verbose); |
e88d6e10 | 433 | int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum, |
801c135c | 434 | struct ubi_ec_hdr *ec_hdr); |
e88d6e10 | 435 | int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum, |
801c135c | 436 | struct ubi_vid_hdr *vid_hdr, int verbose); |
e88d6e10 | 437 | int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum, |
801c135c AB |
438 | struct ubi_vid_hdr *vid_hdr); |
439 | ||
440 | /* | |
441 | * ubi_rb_for_each_entry - walk an RB-tree. | |
442 | * @rb: a pointer to type 'struct rb_node' to to use as a loop counter | |
443 | * @pos: a pointer to RB-tree entry type to use as a loop counter | |
444 | * @root: RB-tree's root | |
445 | * @member: the name of the 'struct rb_node' within the RB-tree entry | |
446 | */ | |
447 | #define ubi_rb_for_each_entry(rb, pos, root, member) \ | |
448 | for (rb = rb_first(root), \ | |
449 | pos = (rb ? container_of(rb, typeof(*pos), member) : NULL); \ | |
450 | rb; \ | |
451 | rb = rb_next(rb), pos = container_of(rb, typeof(*pos), member)) | |
452 | ||
453 | /** | |
454 | * ubi_zalloc_vid_hdr - allocate a volume identifier header object. | |
455 | * @ubi: UBI device description object | |
33818bbb | 456 | * @gfp_flags: GFP flags to allocate with |
801c135c AB |
457 | * |
458 | * This function returns a pointer to the newly allocated and zero-filled | |
459 | * volume identifier header object in case of success and %NULL in case of | |
460 | * failure. | |
461 | */ | |
33818bbb AB |
462 | static inline struct ubi_vid_hdr * |
463 | ubi_zalloc_vid_hdr(const struct ubi_device *ubi, gfp_t gfp_flags) | |
801c135c AB |
464 | { |
465 | void *vid_hdr; | |
466 | ||
33818bbb | 467 | vid_hdr = kzalloc(ubi->vid_hdr_alsize, gfp_flags); |
801c135c AB |
468 | if (!vid_hdr) |
469 | return NULL; | |
470 | ||
471 | /* | |
472 | * VID headers may be stored at un-aligned flash offsets, so we shift | |
473 | * the pointer. | |
474 | */ | |
475 | return vid_hdr + ubi->vid_hdr_shift; | |
476 | } | |
477 | ||
478 | /** | |
479 | * ubi_free_vid_hdr - free a volume identifier header object. | |
480 | * @ubi: UBI device description object | |
481 | * @vid_hdr: the object to free | |
482 | */ | |
483 | static inline void ubi_free_vid_hdr(const struct ubi_device *ubi, | |
484 | struct ubi_vid_hdr *vid_hdr) | |
485 | { | |
486 | void *p = vid_hdr; | |
487 | ||
488 | if (!p) | |
489 | return; | |
490 | ||
491 | kfree(p - ubi->vid_hdr_shift); | |
492 | } | |
493 | ||
494 | /* | |
495 | * This function is equivalent to 'ubi_io_read()', but @offset is relative to | |
496 | * the beginning of the logical eraseblock, not to the beginning of the | |
497 | * physical eraseblock. | |
498 | */ | |
499 | static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf, | |
500 | int pnum, int offset, int len) | |
501 | { | |
502 | ubi_assert(offset >= 0); | |
503 | return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len); | |
504 | } | |
505 | ||
506 | /* | |
507 | * This function is equivalent to 'ubi_io_write()', but @offset is relative to | |
508 | * the beginning of the logical eraseblock, not to the beginning of the | |
509 | * physical eraseblock. | |
510 | */ | |
e88d6e10 | 511 | static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf, |
801c135c AB |
512 | int pnum, int offset, int len) |
513 | { | |
514 | ubi_assert(offset >= 0); | |
515 | return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len); | |
516 | } | |
517 | ||
518 | /** | |
519 | * ubi_ro_mode - switch to read-only mode. | |
520 | * @ubi: UBI device description object | |
521 | */ | |
522 | static inline void ubi_ro_mode(struct ubi_device *ubi) | |
523 | { | |
524 | ubi->ro_mode = 1; | |
525 | ubi_warn("switch to read-only mode"); | |
526 | } | |
527 | ||
528 | /** | |
529 | * vol_id2idx - get table index by volume ID. | |
530 | * @ubi: UBI device description object | |
531 | * @vol_id: volume ID | |
532 | */ | |
533 | static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id) | |
534 | { | |
535 | if (vol_id >= UBI_INTERNAL_VOL_START) | |
536 | return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots; | |
537 | else | |
538 | return vol_id; | |
539 | } | |
540 | ||
541 | /** | |
542 | * idx2vol_id - get volume ID by table index. | |
543 | * @ubi: UBI device description object | |
544 | * @idx: table index | |
545 | */ | |
546 | static inline int idx2vol_id(const struct ubi_device *ubi, int idx) | |
547 | { | |
548 | if (idx >= ubi->vtbl_slots) | |
549 | return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START; | |
550 | else | |
551 | return idx; | |
552 | } | |
553 | ||
554 | #endif /* !__UBI_UBI_H__ */ |