drivers/mtd/ubi/ubi.h

   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/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>
  33 #include <linux/fs.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>
  43
  44 #include "ubi-media.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 struct ubi_device;
  53
  54 /* Normal UBI messages */
  55 __printf(2, 3)
  56 void ubi_msg(const struct ubi_device *ubi, const char *fmt, ...);
  57
  58 /* UBI warning messages */
  59 __printf(2, 3)
  60 void ubi_warn(const struct ubi_device *ubi, const char *fmt, ...);
  61
  62 /* UBI error messages */
  63 __printf(2, 3)
  64 void ubi_err(const struct ubi_device *ubi, const char *fmt, ...);
  65
  66 /* Background thread name pattern */
  67 #define UBI_BGT_NAME_PATTERN "ubi_bgt%dd"
  68
  69 /*
  70  * This marker in the EBA table means that the LEB is um-mapped.
  71  * NOTE! It has to have the same value as %UBI_ALL.
  72  */
  73 #define UBI_LEB_UNMAPPED -1
  74
  75 /*
  76  * In case of errors, UBI tries to repeat the operation several times before
  77  * returning error. The below constant defines how many times UBI re-tries.
  78  */
  79 #define UBI_IO_RETRIES 3
  80
  81 /*
  82  * Length of the protection queue. The length is effectively equivalent to the
  83  * number of (global) erase cycles PEBs are protected from the wear-leveling
  84  * worker.
  85  */
  86 #define UBI_PROT_QUEUE_LEN 10
  87
  88 /* The volume ID/LEB number/erase counter is unknown */
  89 #define UBI_UNKNOWN -1
  90
  91 /*
  92  * The UBI debugfs directory name pattern and maximum name length (3 for "ubi"
  93  * + 2 for the number plus 1 for the trailing zero byte.
  94  */
  95 #define UBI_DFS_DIR_NAME "ubi%d"
  96 #define UBI_DFS_DIR_LEN  (3 + 2 + 1)
  97
  98 /*
  99  * Error codes returned by the I/O sub-system.
 100  *
 101  * UBI_IO_FF: the read region of flash contains only 0xFFs
 102  * UBI_IO_FF_BITFLIPS: the same as %UBI_IO_FF, but also also there was a data
 103  *                     integrity error reported by the MTD driver
 104  *                     (uncorrectable ECC error in case of NAND)
 105  * UBI_IO_BAD_HDR: the EC or VID header is corrupted (bad magic or CRC)
 106  * UBI_IO_BAD_HDR_EBADMSG: the same as %UBI_IO_BAD_HDR, but also there was a
 107  *                         data integrity error reported by the MTD driver
 108  *                         (uncorrectable ECC error in case of NAND)
 109  * UBI_IO_BITFLIPS: bit-flips were detected and corrected
 110  *
 111  * Note, it is probably better to have bit-flip and ebadmsg as flags which can
 112  * be or'ed with other error code. But this is a big change because there are
 113  * may callers, so it does not worth the risk of introducing a bug
 114  */
 115 enum {
 116         UBI_IO_FF = 1,
 117         UBI_IO_FF_BITFLIPS,
 118         UBI_IO_BAD_HDR,
 119         UBI_IO_BAD_HDR_EBADMSG,
 120         UBI_IO_BITFLIPS,
 121 };
 122
 123 /*
 124  * Return codes of the 'ubi_eba_copy_leb()' function.
 125  *
 126  * MOVE_CANCEL_RACE: canceled because the volume is being deleted, the source
 127  *                   PEB was put meanwhile, or there is I/O on the source PEB
 128  * MOVE_SOURCE_RD_ERR: canceled because there was a read error from the source
 129  *                     PEB
 130  * MOVE_TARGET_RD_ERR: canceled because there was a read error from the target
 131  *                     PEB
 132  * MOVE_TARGET_WR_ERR: canceled because there was a write error to the target
 133  *                     PEB
 134  * MOVE_TARGET_BITFLIPS: canceled because a bit-flip was detected in the
 135  *                       target PEB
 136  * MOVE_RETRY: retry scrubbing the PEB
 137  */
 138 enum {
 139         MOVE_CANCEL_RACE = 1,
 140         MOVE_SOURCE_RD_ERR,
 141         MOVE_TARGET_RD_ERR,
 142         MOVE_TARGET_WR_ERR,
 143         MOVE_TARGET_BITFLIPS,
 144         MOVE_RETRY,
 145 };
 146
 147 /*
 148  * Return codes of the fastmap sub-system
 149  *
 150  * UBI_NO_FASTMAP: No fastmap super block was found
 151  * UBI_BAD_FASTMAP: A fastmap was found but it's unusable
 152  */
 153 enum {
 154         UBI_NO_FASTMAP = 1,
 155         UBI_BAD_FASTMAP,
 156 };
 157
 158 /*
 159  * Flags for emulate_power_cut in ubi_debug_info
 160  *
 161  * POWER_CUT_EC_WRITE: Emulate a power cut when writing an EC header
 162  * POWER_CUT_VID_WRITE: Emulate a power cut when writing a VID header
 163  */
 164 enum {
 165         POWER_CUT_EC_WRITE = 0x01,
 166         POWER_CUT_VID_WRITE = 0x02,
 167 };
 168
 169 /**
 170  * struct ubi_wl_entry - wear-leveling entry.
 171  * @u.rb: link in the corresponding (free/used) RB-tree
 172  * @u.list: link in the protection queue
 173  * @ec: erase counter
 174  * @pnum: physical eraseblock number
 175  *
 176  * This data structure is used in the WL sub-system. Each physical eraseblock
 177  * has a corresponding &struct wl_entry object which may be kept in different
 178  * RB-trees. See WL sub-system for details.
 179  */
 180 struct ubi_wl_entry {
 181         union {
 182                 struct rb_node rb;
 183                 struct list_head list;
 184         } u;
 185         int ec;
 186         int pnum;
 187 };
 188
 189 /**
 190  * struct ubi_ltree_entry - an entry in the lock tree.
 191  * @rb: links RB-tree nodes
 192  * @vol_id: volume ID of the locked logical eraseblock
 193  * @lnum: locked logical eraseblock number
 194  * @users: how many tasks are using this logical eraseblock or wait for it
 195  * @mutex: read/write mutex to implement read/write access serialization to
 196  *         the (@vol_id, @lnum) logical eraseblock
 197  *
 198  * This data structure is used in the EBA sub-system to implement per-LEB
 199  * locking. When a logical eraseblock is being locked - corresponding
 200  * &struct ubi_ltree_entry object is inserted to the lock tree (@ubi->ltree).
 201  * See EBA sub-system for details.
 202  */
 203 struct ubi_ltree_entry {
 204         struct rb_node rb;
 205         int vol_id;
 206         int lnum;
 207         int users;
 208         struct rw_semaphore mutex;
 209 };
 210
 211 /**
 212  * struct ubi_rename_entry - volume re-name description data structure.
 213  * @new_name_len: new volume name length
 214  * @new_name: new volume name
 215  * @remove: if not zero, this volume should be removed, not re-named
 216  * @desc: descriptor of the volume
 217  * @list: links re-name entries into a list
 218  *
 219  * This data structure is utilized in the multiple volume re-name code. Namely,
 220  * UBI first creates a list of &struct ubi_rename_entry objects from the
 221  * &struct ubi_rnvol_req request object, and then utilizes this list to do all
 222  * the job.
 223  */
 224 struct ubi_rename_entry {
 225         int new_name_len;
 226         char new_name[UBI_VOL_NAME_MAX + 1];
 227         int remove;
 228         struct ubi_volume_desc *desc;
 229         struct list_head list;
 230 };
 231
 232 struct ubi_volume_desc;
 233
 234 /**
 235  * struct ubi_fastmap_layout - in-memory fastmap data structure.
 236  * @e: PEBs used by the current fastmap
 237  * @to_be_tortured: if non-zero tortured this PEB
 238  * @used_blocks: number of used PEBs
 239  * @max_pool_size: maximal size of the user pool
 240  * @max_wl_pool_size: maximal size of the pool used by the WL sub-system
 241  */
 242 struct ubi_fastmap_layout {
 243         struct ubi_wl_entry *e[UBI_FM_MAX_BLOCKS];
 244         int to_be_tortured[UBI_FM_MAX_BLOCKS];
 245         int used_blocks;
 246         int max_pool_size;
 247         int max_wl_pool_size;
 248 };
 249
 250 /**
 251  * struct ubi_fm_pool - in-memory fastmap pool
 252  * @pebs: PEBs in this pool
 253  * @used: number of used PEBs
 254  * @size: total number of PEBs in this pool
 255  * @max_size: maximal size of the pool
 256  *
 257  * A pool gets filled with up to max_size.
 258  * If all PEBs within the pool are used a new fastmap will be written
 259  * to the flash and the pool gets refilled with empty PEBs.
 260  *
 261  */
 262 struct ubi_fm_pool {
 263         int pebs[UBI_FM_MAX_POOL_SIZE];
 264         int used;
 265         int size;
 266         int max_size;
 267 };
 268
 269 /**
 270  * struct ubi_eba_leb_desc - EBA logical eraseblock descriptor
 271  * @lnum: the logical eraseblock number
 272  * @pnum: the physical eraseblock where the LEB can be found
 273  *
 274  * This structure is here to hide EBA's internal from other part of the
 275  * UBI implementation.
 276  *
 277  * One can query the position of a LEB by calling ubi_eba_get_ldesc().
 278  */
 279 struct ubi_eba_leb_desc {
 280         int lnum;
 281         int pnum;
 282 };
 283
 284 /**
 285  * struct ubi_volume - UBI volume description data structure.
 286  * @dev: device object to make use of the the Linux device model
 287  * @cdev: character device object to create character device
 288  * @ubi: reference to the UBI device description object
 289  * @vol_id: volume ID
 290  * @ref_count: volume reference count
 291  * @readers: number of users holding this volume in read-only mode
 292  * @writers: number of users holding this volume in read-write mode
 293  * @exclusive: whether somebody holds this volume in exclusive mode
 294  * @metaonly: whether somebody is altering only meta data of this volume
 295  *
 296  * @reserved_pebs: how many physical eraseblocks are reserved for this volume
 297  * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
 298  * @usable_leb_size: logical eraseblock size without padding
 299  * @used_ebs: how many logical eraseblocks in this volume contain data
 300  * @last_eb_bytes: how many bytes are stored in the last logical eraseblock
 301  * @used_bytes: how many bytes of data this volume contains
 302  * @alignment: volume alignment
 303  * @data_pad: how many bytes are not used at the end of physical eraseblocks to
 304  *            satisfy the requested alignment
 305  * @name_len: volume name length
 306  * @name: volume name
 307  *
 308  * @upd_ebs: how many eraseblocks are expected to be updated
 309  * @ch_lnum: LEB number which is being changing by the atomic LEB change
 310  *           operation
 311  * @upd_bytes: how many bytes are expected to be received for volume update or
 312  *             atomic LEB change
 313  * @upd_received: how many bytes were already received for volume update or
 314  *                atomic LEB change
 315  * @upd_buf: update buffer which is used to collect update data or data for
 316  *           atomic LEB change
 317  *
 318  * @eba_tbl: EBA table of this volume (LEB->PEB mapping)
 319  * @checked: %1 if this static volume was checked
 320  * @corrupted: %1 if the volume is corrupted (static volumes only)
 321  * @upd_marker: %1 if the update marker is set for this volume
 322  * @updating: %1 if the volume is being updated
 323  * @changing_leb: %1 if the atomic LEB change ioctl command is in progress
 324  * @direct_writes: %1 if direct writes are enabled for this volume
 325  *
 326  * The @corrupted field indicates that the volume's contents is corrupted.
 327  * Since UBI protects only static volumes, this field is not relevant to
 328  * dynamic volumes - it is user's responsibility to assure their data
 329  * integrity.
 330  *
 331  * The @upd_marker flag indicates that this volume is either being updated at
 332  * the moment or is damaged because of an unclean reboot.
 333  */
 334 struct ubi_volume {
 335         struct device dev;
 336         struct cdev cdev;
 337         struct ubi_device *ubi;
 338         int vol_id;
 339         int ref_count;
 340         int readers;
 341         int writers;
 342         int exclusive;
 343         int metaonly;
 344
 345         int reserved_pebs;
 346         int vol_type;
 347         int usable_leb_size;
 348         int used_ebs;
 349         int last_eb_bytes;
 350         long long used_bytes;
 351         int alignment;
 352         int data_pad;
 353         int name_len;
 354         char name[UBI_VOL_NAME_MAX + 1];
 355
 356         int upd_ebs;
 357         int ch_lnum;
 358         long long upd_bytes;
 359         long long upd_received;
 360         void *upd_buf;
 361
 362         struct ubi_eba_table *eba_tbl;
 363         unsigned int checked:1;
 364         unsigned int corrupted:1;
 365         unsigned int upd_marker:1;
 366         unsigned int updating:1;
 367         unsigned int changing_leb:1;
 368         unsigned int direct_writes:1;
 369 };
 370
 371 /**
 372  * struct ubi_volume_desc - UBI volume descriptor returned when it is opened.
 373  * @vol: reference to the corresponding volume description object
 374  * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, %UBI_EXCLUSIVE
 375  * or %UBI_METAONLY)
 376  */
 377 struct ubi_volume_desc {
 378         struct ubi_volume *vol;
 379         int mode;
 380 };
 381
 382 struct ubi_wl_entry;
 383
 384 /**
 385  * struct ubi_debug_info - debugging information for an UBI device.
 386  *
 387  * @chk_gen: if UBI general extra checks are enabled
 388  * @chk_io: if UBI I/O extra checks are enabled
 389  * @chk_fastmap: if UBI fastmap extra checks are enabled
 390  * @disable_bgt: disable the background task for testing purposes
 391  * @emulate_bitflips: emulate bit-flips for testing purposes
 392  * @emulate_io_failures: emulate write/erase failures for testing purposes
 393  * @emulate_power_cut: emulate power cut for testing purposes
 394  * @power_cut_counter: count down for writes left until emulated power cut
 395  * @power_cut_min: minimum number of writes before emulating a power cut
 396  * @power_cut_max: maximum number of writes until emulating a power cut
 397  * @dfs_dir_name: name of debugfs directory containing files of this UBI device
 398  * @dfs_dir: direntry object of the UBI device debugfs directory
 399  * @dfs_chk_gen: debugfs knob to enable UBI general extra checks
 400  * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks
 401  * @dfs_chk_fastmap: debugfs knob to enable UBI fastmap extra checks
 402  * @dfs_disable_bgt: debugfs knob to disable the background task
 403  * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips
 404  * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures
 405  * @dfs_emulate_power_cut: debugfs knob to emulate power cuts
 406  * @dfs_power_cut_min: debugfs knob for minimum writes before power cut
 407  * @dfs_power_cut_max: debugfs knob for maximum writes until power cut
 408  */
 409 struct ubi_debug_info {
 410         unsigned int chk_gen:1;
 411         unsigned int chk_io:1;
 412         unsigned int chk_fastmap:1;
 413         unsigned int disable_bgt:1;
 414         unsigned int emulate_bitflips:1;
 415         unsigned int emulate_io_failures:1;
 416         unsigned int emulate_power_cut:2;
 417         unsigned int power_cut_counter;
 418         unsigned int power_cut_min;
 419         unsigned int power_cut_max;
 420         char dfs_dir_name[UBI_DFS_DIR_LEN + 1];
 421         struct dentry *dfs_dir;
 422         struct dentry *dfs_chk_gen;
 423         struct dentry *dfs_chk_io;
 424         struct dentry *dfs_chk_fastmap;
 425         struct dentry *dfs_disable_bgt;
 426         struct dentry *dfs_emulate_bitflips;
 427         struct dentry *dfs_emulate_io_failures;
 428         struct dentry *dfs_emulate_power_cut;
 429         struct dentry *dfs_power_cut_min;
 430         struct dentry *dfs_power_cut_max;
 431 };
 432
 433 /**
 434  * struct ubi_device - UBI device description structure
 435  * @dev: UBI device object to use the the Linux device model
 436  * @cdev: character device object to create character device
 437  * @ubi_num: UBI device number
 438  * @ubi_name: UBI device name
 439  * @vol_count: number of volumes in this UBI device
 440  * @volumes: volumes of this UBI device
 441  * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs,
 442  *                @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count,
 443  *                @vol->readers, @vol->writers, @vol->exclusive,
 444  *                @vol->metaonly, @vol->ref_count, @vol->mapping and
 445  *                @vol->eba_tbl.
 446  * @ref_count: count of references on the UBI device
 447  * @image_seq: image sequence number recorded on EC headers
 448  *
 449  * @rsvd_pebs: count of reserved physical eraseblocks
 450  * @avail_pebs: count of available physical eraseblocks
 451  * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB
 452  *                 handling
 453  * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling
 454  *
 455  * @autoresize_vol_id: ID of the volume which has to be auto-resized at the end
 456  *                     of UBI initialization
 457  * @vtbl_slots: how many slots are available in the volume table
 458  * @vtbl_size: size of the volume table in bytes
 459  * @vtbl: in-RAM volume table copy
 460  * @device_mutex: protects on-flash volume table and serializes volume
 461  *                creation, deletion, update, re-size, re-name and set
 462  *                property
 463  *
 464  * @max_ec: current highest erase counter value
 465  * @mean_ec: current mean erase counter value
 466  *
 467  * @global_sqnum: global sequence number
 468  * @ltree_lock: protects the lock tree and @global_sqnum
 469  * @ltree: the lock tree
 470  * @alc_mutex: serializes "atomic LEB change" operations
 471  *
 472  * @fm_disabled: non-zero if fastmap is disabled (default)
 473  * @fm: in-memory data structure of the currently used fastmap
 474  * @fm_pool: in-memory data structure of the fastmap pool
 475  * @fm_wl_pool: in-memory data structure of the fastmap pool used by the WL
 476  *              sub-system
 477  * @fm_protect: serializes ubi_update_fastmap(), protects @fm_buf and makes sure
 478  * that critical sections cannot be interrupted by ubi_update_fastmap()
 479  * @fm_buf: vmalloc()'d buffer which holds the raw fastmap
 480  * @fm_size: fastmap size in bytes
 481  * @fm_eba_sem: allows ubi_update_fastmap() to block EBA table changes
 482  * @fm_work: fastmap work queue
 483  * @fm_work_scheduled: non-zero if fastmap work was scheduled
 484  * @fast_attach: non-zero if UBI was attached by fastmap
 485  *
 486  * @used: RB-tree of used physical eraseblocks
 487  * @erroneous: RB-tree of erroneous used physical eraseblocks
 488  * @free: RB-tree of free physical eraseblocks
 489  * @free_count: Contains the number of elements in @free
 490  * @scrub: RB-tree of physical eraseblocks which need scrubbing
 491  * @pq: protection queue (contain physical eraseblocks which are temporarily
 492  *      protected from the wear-leveling worker)
 493  * @pq_head: protection queue head
 494  * @wl_lock: protects the @used, @free, @pq, @pq_head, @lookuptbl, @move_from,
 495  *           @move_to, @move_to_put @erase_pending, @wl_scheduled, @works,
 496  *           @erroneous, @erroneous_peb_count, @fm_work_scheduled, @fm_pool,
 497  *           and @fm_wl_pool fields
 498  * @move_mutex: serializes eraseblock moves
 499  * @work_sem: used to wait for all the scheduled works to finish and prevent
 500  * new works from being submitted
 501  * @wl_scheduled: non-zero if the wear-leveling was scheduled
 502  * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
 503  *             physical eraseblock
 504  * @move_from: physical eraseblock from where the data is being moved
 505  * @move_to: physical eraseblock where the data is being moved to
 506  * @move_to_put: if the "to" PEB was put
 507  * @works: list of pending works
 508  * @works_count: count of pending works
 509  * @bgt_thread: background thread description object
 510  * @thread_enabled: if the background thread is enabled
 511  * @bgt_name: background thread name
 512  *
 513  * @flash_size: underlying MTD device size (in bytes)
 514  * @peb_count: count of physical eraseblocks on the MTD device
 515  * @peb_size: physical eraseblock size
 516  * @bad_peb_limit: top limit of expected bad physical eraseblocks
 517  * @bad_peb_count: count of bad physical eraseblocks
 518  * @good_peb_count: count of good physical eraseblocks
 519  * @corr_peb_count: count of corrupted physical eraseblocks (preserved and not
 520  *                  used by UBI)
 521  * @erroneous_peb_count: count of erroneous physical eraseblocks in @erroneous
 522  * @max_erroneous: maximum allowed amount of erroneous physical eraseblocks
 523  * @min_io_size: minimal input/output unit size of the underlying MTD device
 524  * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers
 525  * @ro_mode: if the UBI device is in read-only mode
 526  * @leb_size: logical eraseblock size
 527  * @leb_start: starting offset of logical eraseblocks within physical
 528  *             eraseblocks
 529  * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size
 530  * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size
 531  * @vid_hdr_offset: starting offset of the volume identifier header (might be
 532  *                  unaligned)
 533  * @vid_hdr_aloffset: starting offset of the VID header aligned to
 534  *                    @hdrs_min_io_size
 535  * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset
 536  * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or
 537  *               not
 538  * @nor_flash: non-zero if working on top of NOR flash
 539  * @max_write_size: maximum amount of bytes the underlying flash can write at a
 540  *                  time (MTD write buffer size)
 541  * @mtd: MTD device descriptor
 542  *
 543  * @peb_buf: a buffer of PEB size used for different purposes
 544  * @buf_mutex: protects @peb_buf
 545  * @ckvol_mutex: serializes static volume checking when opening
 546  *
 547  * @dbg: debugging information for this UBI device
 548  */
 549 struct ubi_device {
 550         struct cdev cdev;
 551         struct device dev;
 552         int ubi_num;
 553         char ubi_name[sizeof(UBI_NAME_STR)+5];
 554         int vol_count;
 555         struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT];
 556         spinlock_t volumes_lock;
 557         int ref_count;
 558         int image_seq;
 559
 560         int rsvd_pebs;
 561         int avail_pebs;
 562         int beb_rsvd_pebs;
 563         int beb_rsvd_level;
 564         int bad_peb_limit;
 565
 566         int autoresize_vol_id;
 567         int vtbl_slots;
 568         int vtbl_size;
 569         struct ubi_vtbl_record *vtbl;
 570         struct mutex device_mutex;
 571
 572         int max_ec;
 573         /* Note, mean_ec is not updated run-time - should be fixed */
 574         int mean_ec;
 575
 576         /* EBA sub-system's stuff */
 577         unsigned long long global_sqnum;
 578         spinlock_t ltree_lock;
 579         struct rb_root ltree;
 580         struct mutex alc_mutex;
 581
 582         /* Fastmap stuff */
 583         int fm_disabled;
 584         struct ubi_fastmap_layout *fm;
 585         struct ubi_fm_pool fm_pool;
 586         struct ubi_fm_pool fm_wl_pool;
 587         struct rw_semaphore fm_eba_sem;
 588         struct rw_semaphore fm_protect;
 589         void *fm_buf;
 590         size_t fm_size;
 591         struct work_struct fm_work;
 592         int fm_work_scheduled;
 593         int fast_attach;
 594
 595         /* Wear-leveling sub-system's stuff */
 596         struct rb_root used;
 597         struct rb_root erroneous;
 598         struct rb_root free;
 599         int free_count;
 600         struct rb_root scrub;
 601         struct list_head pq[UBI_PROT_QUEUE_LEN];
 602         int pq_head;
 603         spinlock_t wl_lock;
 604         struct mutex move_mutex;
 605         struct rw_semaphore work_sem;
 606         int wl_scheduled;
 607         struct ubi_wl_entry **lookuptbl;
 608         struct ubi_wl_entry *move_from;
 609         struct ubi_wl_entry *move_to;
 610         int move_to_put;
 611         struct list_head works;
 612         int works_count;
 613         struct task_struct *bgt_thread;
 614         int thread_enabled;
 615         char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2];
 616
 617         /* I/O sub-system's stuff */
 618         long long flash_size;
 619         int peb_count;
 620         int peb_size;
 621         int bad_peb_count;
 622         int good_peb_count;
 623         int corr_peb_count;
 624         int erroneous_peb_count;
 625         int max_erroneous;
 626         int min_io_size;
 627         int hdrs_min_io_size;
 628         int ro_mode;
 629         int leb_size;
 630         int leb_start;
 631         int ec_hdr_alsize;
 632         int vid_hdr_alsize;
 633         int vid_hdr_offset;
 634         int vid_hdr_aloffset;
 635         int vid_hdr_shift;
 636         unsigned int bad_allowed:1;
 637         unsigned int nor_flash:1;
 638         int max_write_size;
 639         struct mtd_info *mtd;
 640
 641         void *peb_buf;
 642         struct mutex buf_mutex;
 643         struct mutex ckvol_mutex;
 644
 645         struct ubi_debug_info dbg;
 646 };
 647
 648 /**
 649  * struct ubi_ainf_peb - attach information about a physical eraseblock.
 650  * @ec: erase counter (%UBI_UNKNOWN if it is unknown)
 651  * @pnum: physical eraseblock number
 652  * @vol_id: ID of the volume this LEB belongs to
 653  * @lnum: logical eraseblock number
 654  * @scrub: if this physical eraseblock needs scrubbing
 655  * @copy_flag: this LEB is a copy (@copy_flag is set in VID header of this LEB)
 656  * @sqnum: sequence number
 657  * @u: unions RB-tree or @list links
 658  * @u.rb: link in the per-volume RB-tree of &struct ubi_ainf_peb objects
 659  * @u.list: link in one of the eraseblock lists
 660  *
 661  * One object of this type is allocated for each physical eraseblock when
 662  * attaching an MTD device. Note, if this PEB does not belong to any LEB /
 663  * volume, the @vol_id and @lnum fields are initialized to %UBI_UNKNOWN.
 664  */
 665 struct ubi_ainf_peb {
 666         int ec;
 667         int pnum;
 668         int vol_id;
 669         int lnum;
 670         unsigned int scrub:1;
 671         unsigned int copy_flag:1;
 672         unsigned long long sqnum;
 673         union {
 674                 struct rb_node rb;
 675                 struct list_head list;
 676         } u;
 677 };
 678
 679 /**
 680  * struct ubi_ainf_volume - attaching information about a volume.
 681  * @vol_id: volume ID
 682  * @highest_lnum: highest logical eraseblock number in this volume
 683  * @leb_count: number of logical eraseblocks in this volume
 684  * @vol_type: volume type
 685  * @used_ebs: number of used logical eraseblocks in this volume (only for
 686  *            static volumes)
 687  * @last_data_size: amount of data in the last logical eraseblock of this
 688  *                  volume (always equivalent to the usable logical eraseblock
 689  *                  size in case of dynamic volumes)
 690  * @data_pad: how many bytes at the end of logical eraseblocks of this volume
 691  *            are not used (due to volume alignment)
 692  * @compat: compatibility flags of this volume
 693  * @rb: link in the volume RB-tree
 694  * @root: root of the RB-tree containing all the eraseblock belonging to this
 695  *        volume (&struct ubi_ainf_peb objects)
 696  *
 697  * One object of this type is allocated for each volume when attaching an MTD
 698  * device.
 699  */
 700 struct ubi_ainf_volume {
 701         int vol_id;
 702         int highest_lnum;
 703         int leb_count;
 704         int vol_type;
 705         int used_ebs;
 706         int last_data_size;
 707         int data_pad;
 708         int compat;
 709         struct rb_node rb;
 710         struct rb_root root;
 711 };
 712
 713 /**
 714  * struct ubi_attach_info - MTD device attaching information.
 715  * @volumes: root of the volume RB-tree
 716  * @corr: list of corrupted physical eraseblocks
 717  * @free: list of free physical eraseblocks
 718  * @erase: list of physical eraseblocks which have to be erased
 719  * @alien: list of physical eraseblocks which should not be used by UBI (e.g.,
 720  *         those belonging to "preserve"-compatible internal volumes)
 721  * @fastmap: list of physical eraseblocks which relate to fastmap (e.g.,
 722  *           eraseblocks of the current and not yet erased old fastmap blocks)
 723  * @corr_peb_count: count of PEBs in the @corr list
 724  * @empty_peb_count: count of PEBs which are presumably empty (contain only
 725  *                   0xFF bytes)
 726  * @alien_peb_count: count of PEBs in the @alien list
 727  * @bad_peb_count: count of bad physical eraseblocks
 728  * @maybe_bad_peb_count: count of bad physical eraseblocks which are not marked
 729  *                       as bad yet, but which look like bad
 730  * @vols_found: number of volumes found
 731  * @highest_vol_id: highest volume ID
 732  * @is_empty: flag indicating whether the MTD device is empty or not
 733  * @force_full_scan: flag indicating whether we need to do a full scan and drop
 734                      all existing Fastmap data structures
 735  * @min_ec: lowest erase counter value
 736  * @max_ec: highest erase counter value
 737  * @max_sqnum: highest sequence number value
 738  * @mean_ec: mean erase counter value
 739  * @ec_sum: a temporary variable used when calculating @mean_ec
 740  * @ec_count: a temporary variable used when calculating @mean_ec
 741  * @aeb_slab_cache: slab cache for &struct ubi_ainf_peb objects
 742  * @ech: temporary EC header. Only available during scan
 743  * @vidh: temporary VID header. Only available during scan
 744  *
 745  * This data structure contains the result of attaching an MTD device and may
 746  * be used by other UBI sub-systems to build final UBI data structures, further
 747  * error-recovery and so on.
 748  */
 749 struct ubi_attach_info {
 750         struct rb_root volumes;
 751         struct list_head corr;
 752         struct list_head free;
 753         struct list_head erase;
 754         struct list_head alien;
 755         struct list_head fastmap;
 756         int corr_peb_count;
 757         int empty_peb_count;
 758         int alien_peb_count;
 759         int bad_peb_count;
 760         int maybe_bad_peb_count;
 761         int vols_found;
 762         int highest_vol_id;
 763         int is_empty;
 764         int force_full_scan;
 765         int min_ec;
 766         int max_ec;
 767         unsigned long long max_sqnum;
 768         int mean_ec;
 769         uint64_t ec_sum;
 770         int ec_count;
 771         struct kmem_cache *aeb_slab_cache;
 772         struct ubi_ec_hdr *ech;
 773         struct ubi_vid_hdr *vidh;
 774 };
 775
 776 /**
 777  * struct ubi_work - UBI work description data structure.
 778  * @list: a link in the list of pending works
 779  * @func: worker function
 780  * @e: physical eraseblock to erase
 781  * @vol_id: the volume ID on which this erasure is being performed
 782  * @lnum: the logical eraseblock number
 783  * @torture: if the physical eraseblock has to be tortured
 784  * @anchor: produce a anchor PEB to by used by fastmap
 785  *
 786  * The @func pointer points to the worker function. If the @shutdown argument is
 787  * not zero, the worker has to free the resources and exit immediately as the
 788  * WL sub-system is shutting down.
 789  * The worker has to return zero in case of success and a negative error code in
 790  * case of failure.
 791  */
 792 struct ubi_work {
 793         struct list_head list;
 794         int (*func)(struct ubi_device *ubi, struct ubi_work *wrk, int shutdown);
 795         /* The below fields are only relevant to erasure works */
 796         struct ubi_wl_entry *e;
 797         int vol_id;
 798         int lnum;
 799         int torture;
 800         int anchor;
 801 };
 802
 803 #include "debug.h"
 804
 805 extern struct kmem_cache *ubi_wl_entry_slab;
 806 extern const struct file_operations ubi_ctrl_cdev_operations;
 807 extern const struct file_operations ubi_cdev_operations;
 808 extern const struct file_operations ubi_vol_cdev_operations;
 809 extern struct class ubi_class;
 810 extern struct mutex ubi_devices_mutex;
 811 extern struct blocking_notifier_head ubi_notifiers;
 812
 813 /* attach.c */
 814 struct ubi_ainf_peb *ubi_alloc_aeb(struct ubi_attach_info *ai, int pnum,
 815                                    int ec);
 816 void ubi_free_aeb(struct ubi_attach_info *ai, struct ubi_ainf_peb *aeb);
 817 int ubi_add_to_av(struct ubi_device *ubi, struct ubi_attach_info *ai, int pnum,
 818                   int ec, const struct ubi_vid_hdr *vid_hdr, int bitflips);
 819 struct ubi_ainf_volume *ubi_add_av(struct ubi_attach_info *ai, int vol_id);
 820 struct ubi_ainf_volume *ubi_find_av(const struct ubi_attach_info *ai,
 821                                     int vol_id);
 822 void ubi_remove_av(struct ubi_attach_info *ai, struct ubi_ainf_volume *av);
 823 struct ubi_ainf_peb *ubi_early_get_peb(struct ubi_device *ubi,
 824                                        struct ubi_attach_info *ai);
 825 int ubi_attach(struct ubi_device *ubi, int force_scan);
 826 void ubi_destroy_ai(struct ubi_attach_info *ai);
 827
 828 /* vtbl.c */
 829 int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
 830                            struct ubi_vtbl_record *vtbl_rec);
 831 int ubi_vtbl_rename_volumes(struct ubi_device *ubi,
 832                             struct list_head *rename_list);
 833 int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_attach_info *ai);
 834
 835 /* vmt.c */
 836 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req);
 837 int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl);
 838 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs);
 839 int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list);
 840 int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol);
 841 void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol);
 842
 843 /* upd.c */
 844 int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol,
 845                      long long bytes);
 846 int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol,
 847                          const void __user *buf, int count);
 848 int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
 849                          const struct ubi_leb_change_req *req);
 850 int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol,
 851                              const void __user *buf, int count);
 852
 853 /* misc.c */
 854 int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf,
 855                       int length);
 856 int ubi_check_volume(struct ubi_device *ubi, int vol_id);
 857 void ubi_update_reserved(struct ubi_device *ubi);
 858 void ubi_calculate_reserved(struct ubi_device *ubi);
 859 int ubi_check_pattern(const void *buf, uint8_t patt, int size);
 860
 861 static inline bool ubi_leb_valid(struct ubi_volume *vol, int lnum)
 862 {
 863         return lnum >= 0 && lnum < vol->reserved_pebs;
 864 }
 865
 866 /* eba.c */
 867 struct ubi_eba_table *ubi_eba_create_table(struct ubi_volume *vol,
 868                                            int nentries);
 869 void ubi_eba_destroy_table(struct ubi_eba_table *tbl);
 870 void ubi_eba_copy_table(struct ubi_volume *vol, struct ubi_eba_table *dst,
 871                         int nentries);
 872 void ubi_eba_replace_table(struct ubi_volume *vol, struct ubi_eba_table *tbl);
 873 void ubi_eba_get_ldesc(struct ubi_volume *vol, int lnum,
 874                        struct ubi_eba_leb_desc *ldesc);
 875 bool ubi_eba_is_mapped(struct ubi_volume *vol, int lnum);
 876 int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
 877                       int lnum);
 878 int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 879                      void *buf, int offset, int len, int check);
 880 int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
 881                         struct ubi_sgl *sgl, int lnum, int offset, int len,
 882                         int check);
 883 int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 884                       const void *buf, int offset, int len);
 885 int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
 886                          int lnum, const void *buf, int len, int used_ebs);
 887 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
 888                               int lnum, const void *buf, int len);
 889 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
 890                      struct ubi_vid_hdr *vid_hdr);
 891 int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
 892 unsigned long long ubi_next_sqnum(struct ubi_device *ubi);
 893 int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
 894                    struct ubi_attach_info *ai_scan);
 895
 896 /* wl.c */
 897 int ubi_wl_get_peb(struct ubi_device *ubi);
 898 int ubi_wl_put_peb(struct ubi_device *ubi, int vol_id, int lnum,
 899                    int pnum, int torture);
 900 int ubi_wl_flush(struct ubi_device *ubi, int vol_id, int lnum);
 901 int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum);
 902 int ubi_wl_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
 903 void ubi_wl_close(struct ubi_device *ubi);
 904 int ubi_thread(void *u);
 905 struct ubi_wl_entry *ubi_wl_get_fm_peb(struct ubi_device *ubi, int anchor);
 906 int ubi_wl_put_fm_peb(struct ubi_device *ubi, struct ubi_wl_entry *used_e,
 907                       int lnum, int torture);
 908 int ubi_is_erase_work(struct ubi_work *wrk);
 909 void ubi_refill_pools(struct ubi_device *ubi);
 910 int ubi_ensure_anchor_pebs(struct ubi_device *ubi);
 911
 912 /* io.c */
 913 int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
 914                 int len);
 915 int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
 916                  int len);
 917 int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture);
 918 int ubi_io_is_bad(const struct ubi_device *ubi, int pnum);
 919 int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum);
 920 int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
 921                        struct ubi_ec_hdr *ec_hdr, int verbose);
 922 int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
 923                         struct ubi_ec_hdr *ec_hdr);
 924 int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
 925                         struct ubi_vid_hdr *vid_hdr, int verbose);
 926 int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
 927                          struct ubi_vid_hdr *vid_hdr);
 928
 929 /* build.c */
 930 int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,
 931                        int vid_hdr_offset, int max_beb_per1024);
 932 int ubi_detach_mtd_dev(int ubi_num, int anyway);
 933 struct ubi_device *ubi_get_device(int ubi_num);
 934 void ubi_put_device(struct ubi_device *ubi);
 935 struct ubi_device *ubi_get_by_major(int major);
 936 int ubi_major2num(int major);
 937 int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol,
 938                       int ntype);
 939 int ubi_notify_all(struct ubi_device *ubi, int ntype,
 940                    struct notifier_block *nb);
 941 int ubi_enumerate_volumes(struct notifier_block *nb);
 942 void ubi_free_internal_volumes(struct ubi_device *ubi);
 943
 944 /* kapi.c */
 945 void ubi_do_get_device_info(struct ubi_device *ubi, struct ubi_device_info *di);
 946 void ubi_do_get_volume_info(struct ubi_device *ubi, struct ubi_volume *vol,
 947                             struct ubi_volume_info *vi);
 948 /* scan.c */
 949 int ubi_compare_lebs(struct ubi_device *ubi, const struct ubi_ainf_peb *aeb,
 950                       int pnum, const struct ubi_vid_hdr *vid_hdr);
 951
 952 /* fastmap.c */
 953 #ifdef CONFIG_MTD_UBI_FASTMAP
 954 size_t ubi_calc_fm_size(struct ubi_device *ubi);
 955 int ubi_update_fastmap(struct ubi_device *ubi);
 956 int ubi_scan_fastmap(struct ubi_device *ubi, struct ubi_attach_info *ai,
 957                      struct ubi_attach_info *scan_ai);
 958 #else
 959 static inline int ubi_update_fastmap(struct ubi_device *ubi) { return 0; }
 960 #endif
 961
 962 /* block.c */
 963 #ifdef CONFIG_MTD_UBI_BLOCK
 964 int ubiblock_init(void);
 965 void ubiblock_exit(void);
 966 int ubiblock_create(struct ubi_volume_info *vi);
 967 int ubiblock_remove(struct ubi_volume_info *vi);
 968 #else
 969 static inline int ubiblock_init(void) { return 0; }
 970 static inline void ubiblock_exit(void) {}
 971 static inline int ubiblock_create(struct ubi_volume_info *vi)
 972 {
 973         return -ENOSYS;
 974 }
 975 static inline int ubiblock_remove(struct ubi_volume_info *vi)
 976 {
 977         return -ENOSYS;
 978 }
 979 #endif
 980
 981 /*
 982  * ubi_for_each_free_peb - walk the UBI free RB tree.
 983  * @ubi: UBI device description object
 984  * @e: a pointer to a ubi_wl_entry to use as cursor
 985  * @pos: a pointer to RB-tree entry type to use as a loop counter
 986  */
 987 #define ubi_for_each_free_peb(ubi, e, tmp_rb)   \
 988         ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->free, u.rb)
 989
 990 /*
 991  * ubi_for_each_used_peb - walk the UBI used RB tree.
 992  * @ubi: UBI device description object
 993  * @e: a pointer to a ubi_wl_entry to use as cursor
 994  * @pos: a pointer to RB-tree entry type to use as a loop counter
 995  */
 996 #define ubi_for_each_used_peb(ubi, e, tmp_rb)   \
 997         ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->used, u.rb)
 998
 999 /*
1000  * ubi_for_each_scub_peb - walk the UBI scub RB tree.
1001  * @ubi: UBI device description object
1002  * @e: a pointer to a ubi_wl_entry to use as cursor
1003  * @pos: a pointer to RB-tree entry type to use as a loop counter
1004  */
1005 #define ubi_for_each_scrub_peb(ubi, e, tmp_rb)  \
1006         ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->scrub, u.rb)
1007
1008 /*
1009  * ubi_for_each_protected_peb - walk the UBI protection queue.
1010  * @ubi: UBI device description object
1011  * @i: a integer used as counter
1012  * @e: a pointer to a ubi_wl_entry to use as cursor
1013  */
1014 #define ubi_for_each_protected_peb(ubi, i, e)   \
1015         for ((i) = 0; (i) < UBI_PROT_QUEUE_LEN; (i)++)  \
1016                 list_for_each_entry((e), &(ubi->pq[(i)]), u.list)
1017
1018 /*
1019  * ubi_rb_for_each_entry - walk an RB-tree.
1020  * @rb: a pointer to type 'struct rb_node' to use as a loop counter
1021  * @pos: a pointer to RB-tree entry type to use as a loop counter
1022  * @root: RB-tree's root
1023  * @member: the name of the 'struct rb_node' within the RB-tree entry
1024  */
1025 #define ubi_rb_for_each_entry(rb, pos, root, member)                         \
1026         for (rb = rb_first(root),                                            \
1027              pos = (rb ? container_of(rb, typeof(*pos), member) : NULL);     \
1028              rb;                                                             \
1029              rb = rb_next(rb),                                               \
1030              pos = (rb ? container_of(rb, typeof(*pos), member) : NULL))
1031
1032 /*
1033  * ubi_move_aeb_to_list - move a PEB from the volume tree to a list.
1034  *
1035  * @av: volume attaching information
1036  * @aeb: attaching eraseblock information
1037  * @list: the list to move to
1038  */
1039 static inline void ubi_move_aeb_to_list(struct ubi_ainf_volume *av,
1040                                          struct ubi_ainf_peb *aeb,
1041                                          struct list_head *list)
1042 {
1043                 rb_erase(&aeb->u.rb, &av->root);
1044                 list_add_tail(&aeb->u.list, list);
1045 }
1046
1047 /**
1048  * ubi_zalloc_vid_hdr - allocate a volume identifier header object.
1049  * @ubi: UBI device description object
1050  * @gfp_flags: GFP flags to allocate with
1051  *
1052  * This function returns a pointer to the newly allocated and zero-filled
1053  * volume identifier header object in case of success and %NULL in case of
1054  * failure.
1055  */
1056 static inline struct ubi_vid_hdr *
1057 ubi_zalloc_vid_hdr(const struct ubi_device *ubi, gfp_t gfp_flags)
1058 {
1059         void *vid_hdr;
1060
1061         vid_hdr = kzalloc(ubi->vid_hdr_alsize, gfp_flags);
1062         if (!vid_hdr)
1063                 return NULL;
1064
1065         /*
1066          * VID headers may be stored at un-aligned flash offsets, so we shift
1067          * the pointer.
1068          */
1069         return vid_hdr + ubi->vid_hdr_shift;
1070 }
1071
1072 /**
1073  * ubi_free_vid_hdr - free a volume identifier header object.
1074  * @ubi: UBI device description object
1075  * @vid_hdr: the object to free
1076  */
1077 static inline void ubi_free_vid_hdr(const struct ubi_device *ubi,
1078                                     struct ubi_vid_hdr *vid_hdr)
1079 {
1080         void *p = vid_hdr;
1081
1082         if (!p)
1083                 return;
1084
1085         kfree(p - ubi->vid_hdr_shift);
1086 }
1087
1088 /*
1089  * This function is equivalent to 'ubi_io_read()', but @offset is relative to
1090  * the beginning of the logical eraseblock, not to the beginning of the
1091  * physical eraseblock.
1092  */
1093 static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf,
1094                                    int pnum, int offset, int len)
1095 {
1096         ubi_assert(offset >= 0);
1097         return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len);
1098 }
1099
1100 /*
1101  * This function is equivalent to 'ubi_io_write()', but @offset is relative to
1102  * the beginning of the logical eraseblock, not to the beginning of the
1103  * physical eraseblock.
1104  */
1105 static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf,
1106                                     int pnum, int offset, int len)
1107 {
1108         ubi_assert(offset >= 0);
1109         return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len);
1110 }
1111
1112 /**
1113  * ubi_ro_mode - switch to read-only mode.
1114  * @ubi: UBI device description object
1115  */
1116 static inline void ubi_ro_mode(struct ubi_device *ubi)
1117 {
1118         if (!ubi->ro_mode) {
1119                 ubi->ro_mode = 1;
1120                 ubi_warn(ubi, "switch to read-only mode");
1121                 dump_stack();
1122         }
1123 }
1124
1125 /**
1126  * vol_id2idx - get table index by volume ID.
1127  * @ubi: UBI device description object
1128  * @vol_id: volume ID
1129  */
1130 static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id)
1131 {
1132         if (vol_id >= UBI_INTERNAL_VOL_START)
1133                 return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots;
1134         else
1135                 return vol_id;
1136 }
1137
1138 /**
1139  * idx2vol_id - get volume ID by table index.
1140  * @ubi: UBI device description object
1141  * @idx: table index
1142  */
1143 static inline int idx2vol_id(const struct ubi_device *ubi, int idx)
1144 {
1145         if (idx >= ubi->vtbl_slots)
1146                 return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START;
1147         else
1148                 return idx;
1149 }
1150
1151 /**
1152  * ubi_is_fm_vol - check whether a volume ID is a Fastmap volume.
1153  * @vol_id: volume ID
1154  */
1155 static inline bool ubi_is_fm_vol(int vol_id)
1156 {
1157         switch (vol_id) {
1158                 case UBI_FM_SB_VOLUME_ID:
1159                 case UBI_FM_DATA_VOLUME_ID:
1160                 return true;
1161         }
1162
1163         return false;
1164 }
1165
1166 /**
1167  * ubi_find_fm_block - check whether a PEB is part of the current Fastmap.
1168  * @ubi: UBI device description object
1169  * @pnum: physical eraseblock to look for
1170  *
1171  * This function returns a wear leveling object if @pnum relates to the current
1172  * fastmap, @NULL otherwise.
1173  */
1174 static inline struct ubi_wl_entry *ubi_find_fm_block(const struct ubi_device *ubi,
1175                                                      int pnum)
1176 {
1177         int i;
1178
1179         if (ubi->fm) {
1180                 for (i = 0; i < ubi->fm->used_blocks; i++) {
1181                         if (ubi->fm->e[i]->pnum == pnum)
1182                                 return ubi->fm->e[i];
1183                 }
1184         }
1185
1186         return NULL;
1187 }
1188
1189 #endif /* !__UBI_UBI_H__ */