2 * Copyright (c) International Business Machines Corp., 2006
3 * Copyright (c) Nokia Corporation, 2006, 2007
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.
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.
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
19 * Author: Artem Bityutskiy (Битюцкий Артём)
25 #include <linux/types.h>
26 #include <linux/list.h>
27 #include <linux/rbtree.h>
28 #include <linux/sched.h>
29 #include <linux/wait.h>
30 #include <linux/mutex.h>
31 #include <linux/rwsem.h>
32 #include <linux/spinlock.h>
34 #include <linux/cdev.h>
35 #include <linux/device.h>
36 #include <linux/slab.h>
37 #include <linux/string.h>
38 #include <linux/vmalloc.h>
39 #include <linux/notifier.h>
40 #include <linux/mtd/mtd.h>
41 #include <linux/mtd/ubi.h>
42 #include <asm/pgtable.h>
44 #include "ubi-media.h"
46 /* Maximum number of supported UBI devices */
47 #define UBI_MAX_DEVICES 32
49 /* UBI name used for character devices, sysfs, etc */
50 #define UBI_NAME_STR "ubi"
52 /* Normal UBI messages */
53 #define ubi_msg(ubi, fmt, ...) pr_notice(UBI_NAME_STR "%d: " fmt "\n", \
54 ubi->ubi_num, ##__VA_ARGS__)
55 /* UBI warning messages */
56 #define ubi_warn(ubi, fmt, ...) pr_warn(UBI_NAME_STR "%d warning: %s: " fmt "\n", \
57 ubi->ubi_num, __func__, ##__VA_ARGS__)
58 /* UBI error messages */
59 #define ubi_err(ubi, fmt, ...) pr_err(UBI_NAME_STR "%d error: %s: " fmt "\n", \
60 ubi->ubi_num, __func__, ##__VA_ARGS__)
62 /* Background thread name pattern */
63 #define UBI_BGT_NAME_PATTERN "ubi_bgt%dd"
66 * This marker in the EBA table means that the LEB is um-mapped.
67 * NOTE! It has to have the same value as %UBI_ALL.
69 #define UBI_LEB_UNMAPPED -1
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.
75 #define UBI_IO_RETRIES 3
78 * Length of the protection queue. The length is effectively equivalent to the
79 * number of (global) erase cycles PEBs are protected from the wear-leveling
82 #define UBI_PROT_QUEUE_LEN 10
84 /* The volume ID/LEB number/erase counter is unknown */
85 #define UBI_UNKNOWN -1
88 * The UBI debugfs directory name pattern and maximum name length (3 for "ubi"
89 * + 2 for the number plus 1 for the trailing zero byte.
91 #define UBI_DFS_DIR_NAME "ubi%d"
92 #define UBI_DFS_DIR_LEN (3 + 2 + 1)
95 * Error codes returned by the I/O sub-system.
97 * UBI_IO_FF: the read region of flash contains only 0xFFs
98 * UBI_IO_FF_BITFLIPS: the same as %UBI_IO_FF, but also also there was a data
99 * integrity error reported by the MTD driver
100 * (uncorrectable ECC error in case of NAND)
101 * UBI_IO_BAD_HDR: the EC or VID header is corrupted (bad magic or CRC)
102 * UBI_IO_BAD_HDR_EBADMSG: the same as %UBI_IO_BAD_HDR, but also there was a
103 * data integrity error reported by the MTD driver
104 * (uncorrectable ECC error in case of NAND)
105 * UBI_IO_BITFLIPS: bit-flips were detected and corrected
107 * Note, it is probably better to have bit-flip and ebadmsg as flags which can
108 * be or'ed with other error code. But this is a big change because there are
109 * may callers, so it does not worth the risk of introducing a bug
115 UBI_IO_BAD_HDR_EBADMSG,
120 * Return codes of the 'ubi_eba_copy_leb()' function.
122 * MOVE_CANCEL_RACE: canceled because the volume is being deleted, the source
123 * PEB was put meanwhile, or there is I/O on the source PEB
124 * MOVE_SOURCE_RD_ERR: canceled because there was a read error from the source
126 * MOVE_TARGET_RD_ERR: canceled because there was a read error from the target
128 * MOVE_TARGET_WR_ERR: canceled because there was a write error to the target
130 * MOVE_TARGET_BITFLIPS: canceled because a bit-flip was detected in the
132 * MOVE_RETRY: retry scrubbing the PEB
135 MOVE_CANCEL_RACE = 1,
139 MOVE_TARGET_BITFLIPS,
144 * Return codes of the fastmap sub-system
146 * UBI_NO_FASTMAP: No fastmap super block was found
147 * UBI_BAD_FASTMAP: A fastmap was found but it's unusable
155 * struct ubi_wl_entry - wear-leveling entry.
156 * @u.rb: link in the corresponding (free/used) RB-tree
157 * @u.list: link in the protection queue
159 * @pnum: physical eraseblock number
161 * This data structure is used in the WL sub-system. Each physical eraseblock
162 * has a corresponding &struct wl_entry object which may be kept in different
163 * RB-trees. See WL sub-system for details.
165 struct ubi_wl_entry {
168 struct list_head list;
175 * struct ubi_ltree_entry - an entry in the lock tree.
176 * @rb: links RB-tree nodes
177 * @vol_id: volume ID of the locked logical eraseblock
178 * @lnum: locked logical eraseblock number
179 * @users: how many tasks are using this logical eraseblock or wait for it
180 * @mutex: read/write mutex to implement read/write access serialization to
181 * the (@vol_id, @lnum) logical eraseblock
183 * This data structure is used in the EBA sub-system to implement per-LEB
184 * locking. When a logical eraseblock is being locked - corresponding
185 * &struct ubi_ltree_entry object is inserted to the lock tree (@ubi->ltree).
186 * See EBA sub-system for details.
188 struct ubi_ltree_entry {
193 struct rw_semaphore mutex;
197 * struct ubi_rename_entry - volume re-name description data structure.
198 * @new_name_len: new volume name length
199 * @new_name: new volume name
200 * @remove: if not zero, this volume should be removed, not re-named
201 * @desc: descriptor of the volume
202 * @list: links re-name entries into a list
204 * This data structure is utilized in the multiple volume re-name code. Namely,
205 * UBI first creates a list of &struct ubi_rename_entry objects from the
206 * &struct ubi_rnvol_req request object, and then utilizes this list to do all
209 struct ubi_rename_entry {
211 char new_name[UBI_VOL_NAME_MAX + 1];
213 struct ubi_volume_desc *desc;
214 struct list_head list;
217 struct ubi_volume_desc;
220 * struct ubi_fastmap_layout - in-memory fastmap data structure.
221 * @e: PEBs used by the current fastmap
222 * @to_be_tortured: if non-zero tortured this PEB
223 * @used_blocks: number of used PEBs
224 * @max_pool_size: maximal size of the user pool
225 * @max_wl_pool_size: maximal size of the pool used by the WL sub-system
227 struct ubi_fastmap_layout {
228 struct ubi_wl_entry *e[UBI_FM_MAX_BLOCKS];
229 int to_be_tortured[UBI_FM_MAX_BLOCKS];
232 int max_wl_pool_size;
236 * struct ubi_fm_pool - in-memory fastmap pool
237 * @pebs: PEBs in this pool
238 * @used: number of used PEBs
239 * @size: total number of PEBs in this pool
240 * @max_size: maximal size of the pool
242 * A pool gets filled with up to max_size.
243 * If all PEBs within the pool are used a new fastmap will be written
244 * to the flash and the pool gets refilled with empty PEBs.
248 int pebs[UBI_FM_MAX_POOL_SIZE];
255 * struct ubi_volume - UBI volume description data structure.
256 * @dev: device object to make use of the the Linux device model
257 * @cdev: character device object to create character device
258 * @ubi: reference to the UBI device description object
260 * @ref_count: volume reference count
261 * @readers: number of users holding this volume in read-only mode
262 * @writers: number of users holding this volume in read-write mode
263 * @exclusive: whether somebody holds this volume in exclusive mode
264 * @metaonly: whether somebody is altering only meta data of this volume
266 * @reserved_pebs: how many physical eraseblocks are reserved for this volume
267 * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
268 * @usable_leb_size: logical eraseblock size without padding
269 * @used_ebs: how many logical eraseblocks in this volume contain data
270 * @last_eb_bytes: how many bytes are stored in the last logical eraseblock
271 * @used_bytes: how many bytes of data this volume contains
272 * @alignment: volume alignment
273 * @data_pad: how many bytes are not used at the end of physical eraseblocks to
274 * satisfy the requested alignment
275 * @name_len: volume name length
278 * @upd_ebs: how many eraseblocks are expected to be updated
279 * @ch_lnum: LEB number which is being changing by the atomic LEB change
281 * @upd_bytes: how many bytes are expected to be received for volume update or
283 * @upd_received: how many bytes were already received for volume update or
285 * @upd_buf: update buffer which is used to collect update data or data for
288 * @eba_tbl: EBA table of this volume (LEB->PEB mapping)
289 * @checked: %1 if this static volume was checked
290 * @corrupted: %1 if the volume is corrupted (static volumes only)
291 * @upd_marker: %1 if the update marker is set for this volume
292 * @updating: %1 if the volume is being updated
293 * @changing_leb: %1 if the atomic LEB change ioctl command is in progress
294 * @direct_writes: %1 if direct writes are enabled for this volume
296 * The @corrupted field indicates that the volume's contents is corrupted.
297 * Since UBI protects only static volumes, this field is not relevant to
298 * dynamic volumes - it is user's responsibility to assure their data
301 * The @upd_marker flag indicates that this volume is either being updated at
302 * the moment or is damaged because of an unclean reboot.
307 struct ubi_device *ubi;
320 long long used_bytes;
324 char name[UBI_VOL_NAME_MAX + 1];
329 long long upd_received;
333 unsigned int checked:1;
334 unsigned int corrupted:1;
335 unsigned int upd_marker:1;
336 unsigned int updating:1;
337 unsigned int changing_leb:1;
338 unsigned int direct_writes:1;
342 * struct ubi_volume_desc - UBI volume descriptor returned when it is opened.
343 * @vol: reference to the corresponding volume description object
344 * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, %UBI_EXCLUSIVE
347 struct ubi_volume_desc {
348 struct ubi_volume *vol;
355 * struct ubi_debug_info - debugging information for an UBI device.
357 * @chk_gen: if UBI general extra checks are enabled
358 * @chk_io: if UBI I/O extra checks are enabled
359 * @disable_bgt: disable the background task for testing purposes
360 * @emulate_bitflips: emulate bit-flips for testing purposes
361 * @emulate_io_failures: emulate write/erase failures for testing purposes
362 * @dfs_dir_name: name of debugfs directory containing files of this UBI device
363 * @dfs_dir: direntry object of the UBI device debugfs directory
364 * @dfs_chk_gen: debugfs knob to enable UBI general extra checks
365 * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks
366 * @dfs_disable_bgt: debugfs knob to disable the background task
367 * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips
368 * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures
370 struct ubi_debug_info {
371 unsigned int chk_gen:1;
372 unsigned int chk_io:1;
373 unsigned int disable_bgt:1;
374 unsigned int emulate_bitflips:1;
375 unsigned int emulate_io_failures:1;
376 char dfs_dir_name[UBI_DFS_DIR_LEN + 1];
377 struct dentry *dfs_dir;
378 struct dentry *dfs_chk_gen;
379 struct dentry *dfs_chk_io;
380 struct dentry *dfs_disable_bgt;
381 struct dentry *dfs_emulate_bitflips;
382 struct dentry *dfs_emulate_io_failures;
386 * struct ubi_device - UBI device description structure
387 * @dev: UBI device object to use the the Linux device model
388 * @cdev: character device object to create character device
389 * @ubi_num: UBI device number
390 * @ubi_name: UBI device name
391 * @vol_count: number of volumes in this UBI device
392 * @volumes: volumes of this UBI device
393 * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs,
394 * @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count,
395 * @vol->readers, @vol->writers, @vol->exclusive,
396 * @vol->metaonly, @vol->ref_count, @vol->mapping and
398 * @ref_count: count of references on the UBI device
399 * @image_seq: image sequence number recorded on EC headers
401 * @rsvd_pebs: count of reserved physical eraseblocks
402 * @avail_pebs: count of available physical eraseblocks
403 * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB
405 * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling
407 * @autoresize_vol_id: ID of the volume which has to be auto-resized at the end
408 * of UBI initialization
409 * @vtbl_slots: how many slots are available in the volume table
410 * @vtbl_size: size of the volume table in bytes
411 * @vtbl: in-RAM volume table copy
412 * @device_mutex: protects on-flash volume table and serializes volume
413 * creation, deletion, update, re-size, re-name and set
416 * @max_ec: current highest erase counter value
417 * @mean_ec: current mean erase counter value
419 * @global_sqnum: global sequence number
420 * @ltree_lock: protects the lock tree and @global_sqnum
421 * @ltree: the lock tree
422 * @alc_mutex: serializes "atomic LEB change" operations
424 * @fm_disabled: non-zero if fastmap is disabled (default)
425 * @fm: in-memory data structure of the currently used fastmap
426 * @fm_pool: in-memory data structure of the fastmap pool
427 * @fm_wl_pool: in-memory data structure of the fastmap pool used by the WL
429 * @fm_mutex: serializes ubi_update_fastmap() and protects @fm_buf
430 * @fm_buf: vmalloc()'d buffer which holds the raw fastmap
431 * @fm_size: fastmap size in bytes
432 * @fm_sem: allows ubi_update_fastmap() to block EBA table changes
433 * @fm_work: fastmap work queue
434 * @fm_work_scheduled: non-zero if fastmap work was scheduled
436 * @used: RB-tree of used physical eraseblocks
437 * @erroneous: RB-tree of erroneous used physical eraseblocks
438 * @free: RB-tree of free physical eraseblocks
439 * @free_count: Contains the number of elements in @free
440 * @scrub: RB-tree of physical eraseblocks which need scrubbing
441 * @pq: protection queue (contain physical eraseblocks which are temporarily
442 * protected from the wear-leveling worker)
443 * @pq_head: protection queue head
444 * @wl_lock: protects the @used, @free, @pq, @pq_head, @lookuptbl, @move_from,
445 * @move_to, @move_to_put @erase_pending, @wl_scheduled, @works,
446 * @erroneous, @erroneous_peb_count, @fm_work_scheduled, @fm_pool,
447 * and @fm_wl_pool fields
448 * @move_mutex: serializes eraseblock moves
449 * @work_sem: used to wait for all the scheduled works to finish and prevent
450 * new works from being submitted
451 * @wl_scheduled: non-zero if the wear-leveling was scheduled
452 * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
453 * physical eraseblock
454 * @move_from: physical eraseblock from where the data is being moved
455 * @move_to: physical eraseblock where the data is being moved to
456 * @move_to_put: if the "to" PEB was put
457 * @works: list of pending works
458 * @works_count: count of pending works
459 * @bgt_thread: background thread description object
460 * @thread_enabled: if the background thread is enabled
461 * @bgt_name: background thread name
463 * @flash_size: underlying MTD device size (in bytes)
464 * @peb_count: count of physical eraseblocks on the MTD device
465 * @peb_size: physical eraseblock size
466 * @bad_peb_limit: top limit of expected bad physical eraseblocks
467 * @bad_peb_count: count of bad physical eraseblocks
468 * @good_peb_count: count of good physical eraseblocks
469 * @corr_peb_count: count of corrupted physical eraseblocks (preserved and not
471 * @erroneous_peb_count: count of erroneous physical eraseblocks in @erroneous
472 * @max_erroneous: maximum allowed amount of erroneous physical eraseblocks
473 * @min_io_size: minimal input/output unit size of the underlying MTD device
474 * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers
475 * @ro_mode: if the UBI device is in read-only mode
476 * @leb_size: logical eraseblock size
477 * @leb_start: starting offset of logical eraseblocks within physical
479 * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size
480 * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size
481 * @vid_hdr_offset: starting offset of the volume identifier header (might be
483 * @vid_hdr_aloffset: starting offset of the VID header aligned to
485 * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset
486 * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or
488 * @nor_flash: non-zero if working on top of NOR flash
489 * @max_write_size: maximum amount of bytes the underlying flash can write at a
490 * time (MTD write buffer size)
491 * @mtd: MTD device descriptor
493 * @peb_buf: a buffer of PEB size used for different purposes
494 * @buf_mutex: protects @peb_buf
495 * @ckvol_mutex: serializes static volume checking when opening
497 * @dbg: debugging information for this UBI device
503 char ubi_name[sizeof(UBI_NAME_STR)+5];
505 struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT];
506 spinlock_t volumes_lock;
516 int autoresize_vol_id;
519 struct ubi_vtbl_record *vtbl;
520 struct mutex device_mutex;
523 /* Note, mean_ec is not updated run-time - should be fixed */
526 /* EBA sub-system's stuff */
527 unsigned long long global_sqnum;
528 spinlock_t ltree_lock;
529 struct rb_root ltree;
530 struct mutex alc_mutex;
534 struct ubi_fastmap_layout *fm;
535 struct ubi_fm_pool fm_pool;
536 struct ubi_fm_pool fm_wl_pool;
537 struct rw_semaphore fm_sem;
538 struct mutex fm_mutex;
541 struct work_struct fm_work;
542 int fm_work_scheduled;
544 /* Wear-leveling sub-system's stuff */
546 struct rb_root erroneous;
549 struct rb_root scrub;
550 struct list_head pq[UBI_PROT_QUEUE_LEN];
553 struct mutex move_mutex;
554 struct rw_semaphore work_sem;
556 struct ubi_wl_entry **lookuptbl;
557 struct ubi_wl_entry *move_from;
558 struct ubi_wl_entry *move_to;
560 struct list_head works;
562 struct task_struct *bgt_thread;
564 char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2];
566 /* I/O sub-system's stuff */
567 long long flash_size;
573 int erroneous_peb_count;
576 int hdrs_min_io_size;
583 int vid_hdr_aloffset;
585 unsigned int bad_allowed:1;
586 unsigned int nor_flash:1;
588 struct mtd_info *mtd;
591 struct mutex buf_mutex;
592 struct mutex ckvol_mutex;
594 struct ubi_debug_info dbg;
598 * struct ubi_ainf_peb - attach information about a physical eraseblock.
599 * @ec: erase counter (%UBI_UNKNOWN if it is unknown)
600 * @pnum: physical eraseblock number
601 * @vol_id: ID of the volume this LEB belongs to
602 * @lnum: logical eraseblock number
603 * @scrub: if this physical eraseblock needs scrubbing
604 * @copy_flag: this LEB is a copy (@copy_flag is set in VID header of this LEB)
605 * @sqnum: sequence number
606 * @u: unions RB-tree or @list links
607 * @u.rb: link in the per-volume RB-tree of &struct ubi_ainf_peb objects
608 * @u.list: link in one of the eraseblock lists
610 * One object of this type is allocated for each physical eraseblock when
611 * attaching an MTD device. Note, if this PEB does not belong to any LEB /
612 * volume, the @vol_id and @lnum fields are initialized to %UBI_UNKNOWN.
614 struct ubi_ainf_peb {
619 unsigned int scrub:1;
620 unsigned int copy_flag:1;
621 unsigned long long sqnum;
624 struct list_head list;
629 * struct ubi_ainf_volume - attaching information about a volume.
631 * @highest_lnum: highest logical eraseblock number in this volume
632 * @leb_count: number of logical eraseblocks in this volume
633 * @vol_type: volume type
634 * @used_ebs: number of used logical eraseblocks in this volume (only for
636 * @last_data_size: amount of data in the last logical eraseblock of this
637 * volume (always equivalent to the usable logical eraseblock
638 * size in case of dynamic volumes)
639 * @data_pad: how many bytes at the end of logical eraseblocks of this volume
640 * are not used (due to volume alignment)
641 * @compat: compatibility flags of this volume
642 * @rb: link in the volume RB-tree
643 * @root: root of the RB-tree containing all the eraseblock belonging to this
644 * volume (&struct ubi_ainf_peb objects)
646 * One object of this type is allocated for each volume when attaching an MTD
649 struct ubi_ainf_volume {
663 * struct ubi_attach_info - MTD device attaching information.
664 * @volumes: root of the volume RB-tree
665 * @corr: list of corrupted physical eraseblocks
666 * @free: list of free physical eraseblocks
667 * @erase: list of physical eraseblocks which have to be erased
668 * @alien: list of physical eraseblocks which should not be used by UBI (e.g.,
669 * those belonging to "preserve"-compatible internal volumes)
670 * @corr_peb_count: count of PEBs in the @corr list
671 * @empty_peb_count: count of PEBs which are presumably empty (contain only
673 * @alien_peb_count: count of PEBs in the @alien list
674 * @bad_peb_count: count of bad physical eraseblocks
675 * @maybe_bad_peb_count: count of bad physical eraseblocks which are not marked
676 * as bad yet, but which look like bad
677 * @vols_found: number of volumes found
678 * @highest_vol_id: highest volume ID
679 * @is_empty: flag indicating whether the MTD device is empty or not
680 * @min_ec: lowest erase counter value
681 * @max_ec: highest erase counter value
682 * @max_sqnum: highest sequence number value
683 * @mean_ec: mean erase counter value
684 * @ec_sum: a temporary variable used when calculating @mean_ec
685 * @ec_count: a temporary variable used when calculating @mean_ec
686 * @aeb_slab_cache: slab cache for &struct ubi_ainf_peb objects
688 * This data structure contains the result of attaching an MTD device and may
689 * be used by other UBI sub-systems to build final UBI data structures, further
690 * error-recovery and so on.
692 struct ubi_attach_info {
693 struct rb_root volumes;
694 struct list_head corr;
695 struct list_head free;
696 struct list_head erase;
697 struct list_head alien;
702 int maybe_bad_peb_count;
708 unsigned long long max_sqnum;
712 struct kmem_cache *aeb_slab_cache;
716 * struct ubi_work - UBI work description data structure.
717 * @list: a link in the list of pending works
718 * @func: worker function
719 * @e: physical eraseblock to erase
720 * @vol_id: the volume ID on which this erasure is being performed
721 * @lnum: the logical eraseblock number
722 * @torture: if the physical eraseblock has to be tortured
723 * @anchor: produce a anchor PEB to by used by fastmap
725 * The @func pointer points to the worker function. If the @shutdown argument is
726 * not zero, the worker has to free the resources and exit immediately as the
727 * WL sub-system is shutting down.
728 * The worker has to return zero in case of success and a negative error code in
732 struct list_head list;
733 int (*func)(struct ubi_device *ubi, struct ubi_work *wrk, int shutdown);
734 /* The below fields are only relevant to erasure works */
735 struct ubi_wl_entry *e;
744 extern struct kmem_cache *ubi_wl_entry_slab;
745 extern const struct file_operations ubi_ctrl_cdev_operations;
746 extern const struct file_operations ubi_cdev_operations;
747 extern const struct file_operations ubi_vol_cdev_operations;
748 extern struct class *ubi_class;
749 extern struct mutex ubi_devices_mutex;
750 extern struct blocking_notifier_head ubi_notifiers;
753 int ubi_add_to_av(struct ubi_device *ubi, struct ubi_attach_info *ai, int pnum,
754 int ec, const struct ubi_vid_hdr *vid_hdr, int bitflips);
755 struct ubi_ainf_volume *ubi_find_av(const struct ubi_attach_info *ai,
757 void ubi_remove_av(struct ubi_attach_info *ai, struct ubi_ainf_volume *av);
758 struct ubi_ainf_peb *ubi_early_get_peb(struct ubi_device *ubi,
759 struct ubi_attach_info *ai);
760 int ubi_attach(struct ubi_device *ubi, int force_scan);
761 void ubi_destroy_ai(struct ubi_attach_info *ai);
764 int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
765 struct ubi_vtbl_record *vtbl_rec);
766 int ubi_vtbl_rename_volumes(struct ubi_device *ubi,
767 struct list_head *rename_list);
768 int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_attach_info *ai);
771 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req);
772 int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl);
773 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs);
774 int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list);
775 int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol);
776 void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol);
779 int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol,
781 int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol,
782 const void __user *buf, int count);
783 int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
784 const struct ubi_leb_change_req *req);
785 int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol,
786 const void __user *buf, int count);
789 int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf,
791 int ubi_check_volume(struct ubi_device *ubi, int vol_id);
792 void ubi_update_reserved(struct ubi_device *ubi);
793 void ubi_calculate_reserved(struct ubi_device *ubi);
794 int ubi_check_pattern(const void *buf, uint8_t patt, int size);
797 int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
799 int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
800 void *buf, int offset, int len, int check);
801 int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
802 struct ubi_sgl *sgl, int lnum, int offset, int len,
804 int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
805 const void *buf, int offset, int len);
806 int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
807 int lnum, const void *buf, int len, int used_ebs);
808 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
809 int lnum, const void *buf, int len);
810 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
811 struct ubi_vid_hdr *vid_hdr);
812 int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
813 unsigned long long ubi_next_sqnum(struct ubi_device *ubi);
814 int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
815 struct ubi_attach_info *ai_scan);
818 int ubi_wl_get_peb(struct ubi_device *ubi);
819 int ubi_wl_put_peb(struct ubi_device *ubi, int vol_id, int lnum,
820 int pnum, int torture);
821 int ubi_wl_flush(struct ubi_device *ubi, int vol_id, int lnum);
822 int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum);
823 int ubi_wl_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
824 void ubi_wl_close(struct ubi_device *ubi);
825 int ubi_thread(void *u);
826 struct ubi_wl_entry *ubi_wl_get_fm_peb(struct ubi_device *ubi, int anchor);
827 int ubi_wl_put_fm_peb(struct ubi_device *ubi, struct ubi_wl_entry *used_e,
828 int lnum, int torture);
829 int ubi_is_erase_work(struct ubi_work *wrk);
830 void ubi_refill_pools(struct ubi_device *ubi);
831 int ubi_ensure_anchor_pebs(struct ubi_device *ubi);
834 int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
836 int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
838 int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture);
839 int ubi_io_is_bad(const struct ubi_device *ubi, int pnum);
840 int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum);
841 int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
842 struct ubi_ec_hdr *ec_hdr, int verbose);
843 int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
844 struct ubi_ec_hdr *ec_hdr);
845 int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
846 struct ubi_vid_hdr *vid_hdr, int verbose);
847 int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
848 struct ubi_vid_hdr *vid_hdr);
851 int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,
852 int vid_hdr_offset, int max_beb_per1024);
853 int ubi_detach_mtd_dev(int ubi_num, int anyway);
854 struct ubi_device *ubi_get_device(int ubi_num);
855 void ubi_put_device(struct ubi_device *ubi);
856 struct ubi_device *ubi_get_by_major(int major);
857 int ubi_major2num(int major);
858 int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol,
860 int ubi_notify_all(struct ubi_device *ubi, int ntype,
861 struct notifier_block *nb);
862 int ubi_enumerate_volumes(struct notifier_block *nb);
863 void ubi_free_internal_volumes(struct ubi_device *ubi);
866 void ubi_do_get_device_info(struct ubi_device *ubi, struct ubi_device_info *di);
867 void ubi_do_get_volume_info(struct ubi_device *ubi, struct ubi_volume *vol,
868 struct ubi_volume_info *vi);
870 int ubi_compare_lebs(struct ubi_device *ubi, const struct ubi_ainf_peb *aeb,
871 int pnum, const struct ubi_vid_hdr *vid_hdr);
874 #ifdef CONFIG_MTD_UBI_FASTMAP
875 size_t ubi_calc_fm_size(struct ubi_device *ubi);
876 int ubi_update_fastmap(struct ubi_device *ubi);
877 int ubi_scan_fastmap(struct ubi_device *ubi, struct ubi_attach_info *ai,
880 static inline int ubi_update_fastmap(struct ubi_device *ubi) { return 0; }
884 #ifdef CONFIG_MTD_UBI_BLOCK
885 int ubiblock_init(void);
886 void ubiblock_exit(void);
887 int ubiblock_create(struct ubi_volume_info *vi);
888 int ubiblock_remove(struct ubi_volume_info *vi);
890 static inline int ubiblock_init(void) { return 0; }
891 static inline void ubiblock_exit(void) {}
892 static inline int ubiblock_create(struct ubi_volume_info *vi)
896 static inline int ubiblock_remove(struct ubi_volume_info *vi)
904 * ubi_rb_for_each_entry - walk an RB-tree.
905 * @rb: a pointer to type 'struct rb_node' to use as a loop counter
906 * @pos: a pointer to RB-tree entry type to use as a loop counter
907 * @root: RB-tree's root
908 * @member: the name of the 'struct rb_node' within the RB-tree entry
910 #define ubi_rb_for_each_entry(rb, pos, root, member) \
911 for (rb = rb_first(root), \
912 pos = (rb ? container_of(rb, typeof(*pos), member) : NULL); \
915 pos = (rb ? container_of(rb, typeof(*pos), member) : NULL))
918 * ubi_move_aeb_to_list - move a PEB from the volume tree to a list.
920 * @av: volume attaching information
921 * @aeb: attaching eraseblock information
922 * @list: the list to move to
924 static inline void ubi_move_aeb_to_list(struct ubi_ainf_volume *av,
925 struct ubi_ainf_peb *aeb,
926 struct list_head *list)
928 rb_erase(&aeb->u.rb, &av->root);
929 list_add_tail(&aeb->u.list, list);
933 * ubi_zalloc_vid_hdr - allocate a volume identifier header object.
934 * @ubi: UBI device description object
935 * @gfp_flags: GFP flags to allocate with
937 * This function returns a pointer to the newly allocated and zero-filled
938 * volume identifier header object in case of success and %NULL in case of
941 static inline struct ubi_vid_hdr *
942 ubi_zalloc_vid_hdr(const struct ubi_device *ubi, gfp_t gfp_flags)
946 vid_hdr = kzalloc(ubi->vid_hdr_alsize, gfp_flags);
951 * VID headers may be stored at un-aligned flash offsets, so we shift
954 return vid_hdr + ubi->vid_hdr_shift;
958 * ubi_free_vid_hdr - free a volume identifier header object.
959 * @ubi: UBI device description object
960 * @vid_hdr: the object to free
962 static inline void ubi_free_vid_hdr(const struct ubi_device *ubi,
963 struct ubi_vid_hdr *vid_hdr)
970 kfree(p - ubi->vid_hdr_shift);
974 * This function is equivalent to 'ubi_io_read()', but @offset is relative to
975 * the beginning of the logical eraseblock, not to the beginning of the
976 * physical eraseblock.
978 static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf,
979 int pnum, int offset, int len)
981 ubi_assert(offset >= 0);
982 return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len);
986 * This function is equivalent to 'ubi_io_write()', but @offset is relative to
987 * the beginning of the logical eraseblock, not to the beginning of the
988 * physical eraseblock.
990 static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf,
991 int pnum, int offset, int len)
993 ubi_assert(offset >= 0);
994 return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len);
998 * ubi_ro_mode - switch to read-only mode.
999 * @ubi: UBI device description object
1001 static inline void ubi_ro_mode(struct ubi_device *ubi)
1003 if (!ubi->ro_mode) {
1005 ubi_warn(ubi, "switch to read-only mode");
1011 * vol_id2idx - get table index by volume ID.
1012 * @ubi: UBI device description object
1013 * @vol_id: volume ID
1015 static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id)
1017 if (vol_id >= UBI_INTERNAL_VOL_START)
1018 return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots;
1024 * idx2vol_id - get volume ID by table index.
1025 * @ubi: UBI device description object
1028 static inline int idx2vol_id(const struct ubi_device *ubi, int idx)
1030 if (idx >= ubi->vtbl_slots)
1031 return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START;
1036 #endif /* !__UBI_UBI_H__ */