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 /* 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__)
  61
  62 /* Background thread name pattern */
  63 #define UBI_BGT_NAME_PATTERN "ubi_bgt%dd"
  64
  65 /*
  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.
  68  */
  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  * 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
  80  * worker.
  81  */
  82 #define UBI_PROT_QUEUE_LEN 10
  83
  84 /* The volume ID/LEB number/erase counter is unknown */
  85 #define UBI_UNKNOWN -1
  86
  87 /*
  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.
  90  */
  91 #define UBI_DFS_DIR_NAME "ubi%d"
  92 #define UBI_DFS_DIR_LEN  (3 + 2 + 1)
  93
  94 /*
  95  * Error codes returned by the I/O sub-system.
  96  *
  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
 106  *
 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
 110  */
 111 enum {
 112         UBI_IO_FF = 1,
 113         UBI_IO_FF_BITFLIPS,
 114         UBI_IO_BAD_HDR,
 115         UBI_IO_BAD_HDR_EBADMSG,
 116         UBI_IO_BITFLIPS,
 117 };
 118
 119 /*
 120  * Return codes of the 'ubi_eba_copy_leb()' function.
 121  *
 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
 125  *                     PEB
 126  * MOVE_TARGET_RD_ERR: canceled because there was a read error from the target
 127  *                     PEB
 128  * MOVE_TARGET_WR_ERR: canceled because there was a write error to the target
 129  *                     PEB
 130  * MOVE_TARGET_BITFLIPS: canceled because a bit-flip was detected in the
 131  *                       target PEB
 132  * MOVE_RETRY: retry scrubbing the PEB
 133  */
 134 enum {
 135         MOVE_CANCEL_RACE = 1,
 136         MOVE_SOURCE_RD_ERR,
 137         MOVE_TARGET_RD_ERR,
 138         MOVE_TARGET_WR_ERR,
 139         MOVE_TARGET_BITFLIPS,
 140         MOVE_RETRY,
 141 };
 142
 143 /*
 144  * Return codes of the fastmap sub-system
 145  *
 146  * UBI_NO_FASTMAP: No fastmap super block was found
 147  * UBI_BAD_FASTMAP: A fastmap was found but it's unusable
 148  */
 149 enum {
 150         UBI_NO_FASTMAP = 1,
 151         UBI_BAD_FASTMAP,
 152 };
 153
 154 /**
 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
 158  * @ec: erase counter
 159  * @pnum: physical eraseblock number
 160  *
 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.
 164  */
 165 struct ubi_wl_entry {
 166         union {
 167                 struct rb_node rb;
 168                 struct list_head list;
 169         } u;
 170         int ec;
 171         int pnum;
 172 };
 173
 174 /**
 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
 182  *
 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.
 187  */
 188 struct ubi_ltree_entry {
 189         struct rb_node rb;
 190         int vol_id;
 191         int lnum;
 192         int users;
 193         struct rw_semaphore mutex;
 194 };
 195
 196 /**
 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
 203  *
 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
 207  * the job.
 208  */
 209 struct ubi_rename_entry {
 210         int new_name_len;
 211         char new_name[UBI_VOL_NAME_MAX + 1];
 212         int remove;
 213         struct ubi_volume_desc *desc;
 214         struct list_head list;
 215 };
 216
 217 struct ubi_volume_desc;
 218
 219 /**
 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
 226  */
 227 struct ubi_fastmap_layout {
 228         struct ubi_wl_entry *e[UBI_FM_MAX_BLOCKS];
 229         int to_be_tortured[UBI_FM_MAX_BLOCKS];
 230         int used_blocks;
 231         int max_pool_size;
 232         int max_wl_pool_size;
 233 };
 234
 235 /**
 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
 241  *
 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.
 245  *
 246  */
 247 struct ubi_fm_pool {
 248         int pebs[UBI_FM_MAX_POOL_SIZE];
 249         int used;
 250         int size;
 251         int max_size;
 252 };
 253
 254 /**
 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
 259  * @vol_id: volume ID
 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
 265  *
 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
 276  * @name: volume name
 277  *
 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
 280  *           operation
 281  * @upd_bytes: how many bytes are expected to be received for volume update or
 282  *             atomic LEB change
 283  * @upd_received: how many bytes were already received for volume update or
 284  *                atomic LEB change
 285  * @upd_buf: update buffer which is used to collect update data or data for
 286  *           atomic LEB change
 287  *
 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
 295  *
 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
 299  * integrity.
 300  *
 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.
 303  */
 304 struct ubi_volume {
 305         struct device dev;
 306         struct cdev cdev;
 307         struct ubi_device *ubi;
 308         int vol_id;
 309         int ref_count;
 310         int readers;
 311         int writers;
 312         int exclusive;
 313         int metaonly;
 314
 315         int reserved_pebs;
 316         int vol_type;
 317         int usable_leb_size;
 318         int used_ebs;
 319         int last_eb_bytes;
 320         long long used_bytes;
 321         int alignment;
 322         int data_pad;
 323         int name_len;
 324         char name[UBI_VOL_NAME_MAX + 1];
 325
 326         int upd_ebs;
 327         int ch_lnum;
 328         long long upd_bytes;
 329         long long upd_received;
 330         void *upd_buf;
 331
 332         int *eba_tbl;
 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;
 339 };
 340
 341 /**
 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
 345  * or %UBI_METAONLY)
 346  */
 347 struct ubi_volume_desc {
 348         struct ubi_volume *vol;
 349         int mode;
 350 };
 351
 352 struct ubi_wl_entry;
 353
 354 /**
 355  * struct ubi_debug_info - debugging information for an UBI device.
 356  *
 357  * @chk_gen: if UBI general extra checks are enabled
 358  * @chk_io: if UBI I/O extra checks are enabled
 359  * @chk_fastmap: if UBI fastmap extra checks are enabled
 360  * @disable_bgt: disable the background task for testing purposes
 361  * @emulate_bitflips: emulate bit-flips for testing purposes
 362  * @emulate_io_failures: emulate write/erase failures for testing purposes
 363  * @dfs_dir_name: name of debugfs directory containing files of this UBI device
 364  * @dfs_dir: direntry object of the UBI device debugfs directory
 365  * @dfs_chk_gen: debugfs knob to enable UBI general extra checks
 366  * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks
 367  * @dfs_chk_fastmap: debugfs knob to enable UBI fastmap extra checks
 368  * @dfs_disable_bgt: debugfs knob to disable the background task
 369  * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips
 370  * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures
 371  */
 372 struct ubi_debug_info {
 373         unsigned int chk_gen:1;
 374         unsigned int chk_io:1;
 375         unsigned int chk_fastmap:1;
 376         unsigned int disable_bgt:1;
 377         unsigned int emulate_bitflips:1;
 378         unsigned int emulate_io_failures:1;
 379         char dfs_dir_name[UBI_DFS_DIR_LEN + 1];
 380         struct dentry *dfs_dir;
 381         struct dentry *dfs_chk_gen;
 382         struct dentry *dfs_chk_io;
 383         struct dentry *dfs_chk_fastmap;
 384         struct dentry *dfs_disable_bgt;
 385         struct dentry *dfs_emulate_bitflips;
 386         struct dentry *dfs_emulate_io_failures;
 387 };
 388
 389 /**
 390  * struct ubi_device - UBI device description structure
 391  * @dev: UBI device object to use the the Linux device model
 392  * @cdev: character device object to create character device
 393  * @ubi_num: UBI device number
 394  * @ubi_name: UBI device name
 395  * @vol_count: number of volumes in this UBI device
 396  * @volumes: volumes of this UBI device
 397  * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs,
 398  *                @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count,
 399  *                @vol->readers, @vol->writers, @vol->exclusive,
 400  *                @vol->metaonly, @vol->ref_count, @vol->mapping and
 401  *                @vol->eba_tbl.
 402  * @ref_count: count of references on the UBI device
 403  * @image_seq: image sequence number recorded on EC headers
 404  *
 405  * @rsvd_pebs: count of reserved physical eraseblocks
 406  * @avail_pebs: count of available physical eraseblocks
 407  * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB
 408  *                 handling
 409  * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling
 410  *
 411  * @autoresize_vol_id: ID of the volume which has to be auto-resized at the end
 412  *                     of UBI initialization
 413  * @vtbl_slots: how many slots are available in the volume table
 414  * @vtbl_size: size of the volume table in bytes
 415  * @vtbl: in-RAM volume table copy
 416  * @device_mutex: protects on-flash volume table and serializes volume
 417  *                creation, deletion, update, re-size, re-name and set
 418  *                property
 419  *
 420  * @max_ec: current highest erase counter value
 421  * @mean_ec: current mean erase counter value
 422  *
 423  * @global_sqnum: global sequence number
 424  * @ltree_lock: protects the lock tree and @global_sqnum
 425  * @ltree: the lock tree
 426  * @alc_mutex: serializes "atomic LEB change" operations
 427  *
 428  * @fm_disabled: non-zero if fastmap is disabled (default)
 429  * @fm: in-memory data structure of the currently used fastmap
 430  * @fm_pool: in-memory data structure of the fastmap pool
 431  * @fm_wl_pool: in-memory data structure of the fastmap pool used by the WL
 432  *              sub-system
 433  * @fm_protect: serializes ubi_update_fastmap(), protects @fm_buf and makes sure
 434  * that critical sections cannot be interrupted by ubi_update_fastmap()
 435  * @fm_buf: vmalloc()'d buffer which holds the raw fastmap
 436  * @fm_size: fastmap size in bytes
 437  * @fm_eba_sem: allows ubi_update_fastmap() to block EBA table changes
 438  * @fm_work: fastmap work queue
 439  * @fm_work_scheduled: non-zero if fastmap work was scheduled
 440  *
 441  * @used: RB-tree of used physical eraseblocks
 442  * @erroneous: RB-tree of erroneous used physical eraseblocks
 443  * @free: RB-tree of free physical eraseblocks
 444  * @free_count: Contains the number of elements in @free
 445  * @scrub: RB-tree of physical eraseblocks which need scrubbing
 446  * @pq: protection queue (contain physical eraseblocks which are temporarily
 447  *      protected from the wear-leveling worker)
 448  * @pq_head: protection queue head
 449  * @wl_lock: protects the @used, @free, @pq, @pq_head, @lookuptbl, @move_from,
 450  *           @move_to, @move_to_put @erase_pending, @wl_scheduled, @works,
 451  *           @erroneous, @erroneous_peb_count, @fm_work_scheduled, @fm_pool,
 452  *           and @fm_wl_pool fields
 453  * @move_mutex: serializes eraseblock moves
 454  * @work_sem: used to wait for all the scheduled works to finish and prevent
 455  * new works from being submitted
 456  * @wl_scheduled: non-zero if the wear-leveling was scheduled
 457  * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
 458  *             physical eraseblock
 459  * @move_from: physical eraseblock from where the data is being moved
 460  * @move_to: physical eraseblock where the data is being moved to
 461  * @move_to_put: if the "to" PEB was put
 462  * @works: list of pending works
 463  * @works_count: count of pending works
 464  * @bgt_thread: background thread description object
 465  * @thread_enabled: if the background thread is enabled
 466  * @bgt_name: background thread name
 467  *
 468  * @flash_size: underlying MTD device size (in bytes)
 469  * @peb_count: count of physical eraseblocks on the MTD device
 470  * @peb_size: physical eraseblock size
 471  * @bad_peb_limit: top limit of expected bad physical eraseblocks
 472  * @bad_peb_count: count of bad physical eraseblocks
 473  * @good_peb_count: count of good physical eraseblocks
 474  * @corr_peb_count: count of corrupted physical eraseblocks (preserved and not
 475  *                  used by UBI)
 476  * @erroneous_peb_count: count of erroneous physical eraseblocks in @erroneous
 477  * @max_erroneous: maximum allowed amount of erroneous physical eraseblocks
 478  * @min_io_size: minimal input/output unit size of the underlying MTD device
 479  * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers
 480  * @ro_mode: if the UBI device is in read-only mode
 481  * @leb_size: logical eraseblock size
 482  * @leb_start: starting offset of logical eraseblocks within physical
 483  *             eraseblocks
 484  * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size
 485  * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size
 486  * @vid_hdr_offset: starting offset of the volume identifier header (might be
 487  *                  unaligned)
 488  * @vid_hdr_aloffset: starting offset of the VID header aligned to
 489  *                    @hdrs_min_io_size
 490  * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset
 491  * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or
 492  *               not
 493  * @nor_flash: non-zero if working on top of NOR flash
 494  * @max_write_size: maximum amount of bytes the underlying flash can write at a
 495  *                  time (MTD write buffer size)
 496  * @mtd: MTD device descriptor
 497  *
 498  * @peb_buf: a buffer of PEB size used for different purposes
 499  * @buf_mutex: protects @peb_buf
 500  * @ckvol_mutex: serializes static volume checking when opening
 501  *
 502  * @dbg: debugging information for this UBI device
 503  */
 504 struct ubi_device {
 505         struct cdev cdev;
 506         struct device dev;
 507         int ubi_num;
 508         char ubi_name[sizeof(UBI_NAME_STR)+5];
 509         int vol_count;
 510         struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT];
 511         spinlock_t volumes_lock;
 512         int ref_count;
 513         int image_seq;
 514
 515         int rsvd_pebs;
 516         int avail_pebs;
 517         int beb_rsvd_pebs;
 518         int beb_rsvd_level;
 519         int bad_peb_limit;
 520
 521         int autoresize_vol_id;
 522         int vtbl_slots;
 523         int vtbl_size;
 524         struct ubi_vtbl_record *vtbl;
 525         struct mutex device_mutex;
 526
 527         int max_ec;
 528         /* Note, mean_ec is not updated run-time - should be fixed */
 529         int mean_ec;
 530
 531         /* EBA sub-system's stuff */
 532         unsigned long long global_sqnum;
 533         spinlock_t ltree_lock;
 534         struct rb_root ltree;
 535         struct mutex alc_mutex;
 536
 537         /* Fastmap stuff */
 538         int fm_disabled;
 539         struct ubi_fastmap_layout *fm;
 540         struct ubi_fm_pool fm_pool;
 541         struct ubi_fm_pool fm_wl_pool;
 542         struct rw_semaphore fm_eba_sem;
 543         struct rw_semaphore fm_protect;
 544         void *fm_buf;
 545         size_t fm_size;
 546         struct work_struct fm_work;
 547         int fm_work_scheduled;
 548
 549         /* Wear-leveling sub-system's stuff */
 550         struct rb_root used;
 551         struct rb_root erroneous;
 552         struct rb_root free;
 553         int free_count;
 554         struct rb_root scrub;
 555         struct list_head pq[UBI_PROT_QUEUE_LEN];
 556         int pq_head;
 557         spinlock_t wl_lock;
 558         struct mutex move_mutex;
 559         struct rw_semaphore work_sem;
 560         int wl_scheduled;
 561         struct ubi_wl_entry **lookuptbl;
 562         struct ubi_wl_entry *move_from;
 563         struct ubi_wl_entry *move_to;
 564         int move_to_put;
 565         struct list_head works;
 566         int works_count;
 567         struct task_struct *bgt_thread;
 568         int thread_enabled;
 569         char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2];
 570
 571         /* I/O sub-system's stuff */
 572         long long flash_size;
 573         int peb_count;
 574         int peb_size;
 575         int bad_peb_count;
 576         int good_peb_count;
 577         int corr_peb_count;
 578         int erroneous_peb_count;
 579         int max_erroneous;
 580         int min_io_size;
 581         int hdrs_min_io_size;
 582         int ro_mode;
 583         int leb_size;
 584         int leb_start;
 585         int ec_hdr_alsize;
 586         int vid_hdr_alsize;
 587         int vid_hdr_offset;
 588         int vid_hdr_aloffset;
 589         int vid_hdr_shift;
 590         unsigned int bad_allowed:1;
 591         unsigned int nor_flash:1;
 592         int max_write_size;
 593         struct mtd_info *mtd;
 594
 595         void *peb_buf;
 596         struct mutex buf_mutex;
 597         struct mutex ckvol_mutex;
 598
 599         struct ubi_debug_info dbg;
 600 };
 601
 602 /**
 603  * struct ubi_ainf_peb - attach information about a physical eraseblock.
 604  * @ec: erase counter (%UBI_UNKNOWN if it is unknown)
 605  * @pnum: physical eraseblock number
 606  * @vol_id: ID of the volume this LEB belongs to
 607  * @lnum: logical eraseblock number
 608  * @scrub: if this physical eraseblock needs scrubbing
 609  * @copy_flag: this LEB is a copy (@copy_flag is set in VID header of this LEB)
 610  * @sqnum: sequence number
 611  * @u: unions RB-tree or @list links
 612  * @u.rb: link in the per-volume RB-tree of &struct ubi_ainf_peb objects
 613  * @u.list: link in one of the eraseblock lists
 614  *
 615  * One object of this type is allocated for each physical eraseblock when
 616  * attaching an MTD device. Note, if this PEB does not belong to any LEB /
 617  * volume, the @vol_id and @lnum fields are initialized to %UBI_UNKNOWN.
 618  */
 619 struct ubi_ainf_peb {
 620         int ec;
 621         int pnum;
 622         int vol_id;
 623         int lnum;
 624         unsigned int scrub:1;
 625         unsigned int copy_flag:1;
 626         unsigned long long sqnum;
 627         union {
 628                 struct rb_node rb;
 629                 struct list_head list;
 630         } u;
 631 };
 632
 633 /**
 634  * struct ubi_ainf_volume - attaching information about a volume.
 635  * @vol_id: volume ID
 636  * @highest_lnum: highest logical eraseblock number in this volume
 637  * @leb_count: number of logical eraseblocks in this volume
 638  * @vol_type: volume type
 639  * @used_ebs: number of used logical eraseblocks in this volume (only for
 640  *            static volumes)
 641  * @last_data_size: amount of data in the last logical eraseblock of this
 642  *                  volume (always equivalent to the usable logical eraseblock
 643  *                  size in case of dynamic volumes)
 644  * @data_pad: how many bytes at the end of logical eraseblocks of this volume
 645  *            are not used (due to volume alignment)
 646  * @compat: compatibility flags of this volume
 647  * @rb: link in the volume RB-tree
 648  * @root: root of the RB-tree containing all the eraseblock belonging to this
 649  *        volume (&struct ubi_ainf_peb objects)
 650  *
 651  * One object of this type is allocated for each volume when attaching an MTD
 652  * device.
 653  */
 654 struct ubi_ainf_volume {
 655         int vol_id;
 656         int highest_lnum;
 657         int leb_count;
 658         int vol_type;
 659         int used_ebs;
 660         int last_data_size;
 661         int data_pad;
 662         int compat;
 663         struct rb_node rb;
 664         struct rb_root root;
 665 };
 666
 667 /**
 668  * struct ubi_attach_info - MTD device attaching information.
 669  * @volumes: root of the volume RB-tree
 670  * @corr: list of corrupted physical eraseblocks
 671  * @free: list of free physical eraseblocks
 672  * @erase: list of physical eraseblocks which have to be erased
 673  * @alien: list of physical eraseblocks which should not be used by UBI (e.g.,
 674  *         those belonging to "preserve"-compatible internal volumes)
 675  * @corr_peb_count: count of PEBs in the @corr list
 676  * @empty_peb_count: count of PEBs which are presumably empty (contain only
 677  *                   0xFF bytes)
 678  * @alien_peb_count: count of PEBs in the @alien list
 679  * @bad_peb_count: count of bad physical eraseblocks
 680  * @maybe_bad_peb_count: count of bad physical eraseblocks which are not marked
 681  *                       as bad yet, but which look like bad
 682  * @vols_found: number of volumes found
 683  * @highest_vol_id: highest volume ID
 684  * @is_empty: flag indicating whether the MTD device is empty or not
 685  * @min_ec: lowest erase counter value
 686  * @max_ec: highest erase counter value
 687  * @max_sqnum: highest sequence number value
 688  * @mean_ec: mean erase counter value
 689  * @ec_sum: a temporary variable used when calculating @mean_ec
 690  * @ec_count: a temporary variable used when calculating @mean_ec
 691  * @aeb_slab_cache: slab cache for &struct ubi_ainf_peb objects
 692  *
 693  * This data structure contains the result of attaching an MTD device and may
 694  * be used by other UBI sub-systems to build final UBI data structures, further
 695  * error-recovery and so on.
 696  */
 697 struct ubi_attach_info {
 698         struct rb_root volumes;
 699         struct list_head corr;
 700         struct list_head free;
 701         struct list_head erase;
 702         struct list_head alien;
 703         int corr_peb_count;
 704         int empty_peb_count;
 705         int alien_peb_count;
 706         int bad_peb_count;
 707         int maybe_bad_peb_count;
 708         int vols_found;
 709         int highest_vol_id;
 710         int is_empty;
 711         int min_ec;
 712         int max_ec;
 713         unsigned long long max_sqnum;
 714         int mean_ec;
 715         uint64_t ec_sum;
 716         int ec_count;
 717         struct kmem_cache *aeb_slab_cache;
 718 };
 719
 720 /**
 721  * struct ubi_work - UBI work description data structure.
 722  * @list: a link in the list of pending works
 723  * @func: worker function
 724  * @e: physical eraseblock to erase
 725  * @vol_id: the volume ID on which this erasure is being performed
 726  * @lnum: the logical eraseblock number
 727  * @torture: if the physical eraseblock has to be tortured
 728  * @anchor: produce a anchor PEB to by used by fastmap
 729  *
 730  * The @func pointer points to the worker function. If the @shutdown argument is
 731  * not zero, the worker has to free the resources and exit immediately as the
 732  * WL sub-system is shutting down.
 733  * The worker has to return zero in case of success and a negative error code in
 734  * case of failure.
 735  */
 736 struct ubi_work {
 737         struct list_head list;
 738         int (*func)(struct ubi_device *ubi, struct ubi_work *wrk, int shutdown);
 739         /* The below fields are only relevant to erasure works */
 740         struct ubi_wl_entry *e;
 741         int vol_id;
 742         int lnum;
 743         int torture;
 744         int anchor;
 745 };
 746
 747 #include "debug.h"
 748
 749 extern struct kmem_cache *ubi_wl_entry_slab;
 750 extern const struct file_operations ubi_ctrl_cdev_operations;
 751 extern const struct file_operations ubi_cdev_operations;
 752 extern const struct file_operations ubi_vol_cdev_operations;
 753 extern struct class *ubi_class;
 754 extern struct mutex ubi_devices_mutex;
 755 extern struct blocking_notifier_head ubi_notifiers;
 756
 757 /* attach.c */
 758 int ubi_add_to_av(struct ubi_device *ubi, struct ubi_attach_info *ai, int pnum,
 759                   int ec, const struct ubi_vid_hdr *vid_hdr, int bitflips);
 760 struct ubi_ainf_volume *ubi_find_av(const struct ubi_attach_info *ai,
 761                                     int vol_id);
 762 void ubi_remove_av(struct ubi_attach_info *ai, struct ubi_ainf_volume *av);
 763 struct ubi_ainf_peb *ubi_early_get_peb(struct ubi_device *ubi,
 764                                        struct ubi_attach_info *ai);
 765 int ubi_attach(struct ubi_device *ubi, int force_scan);
 766 void ubi_destroy_ai(struct ubi_attach_info *ai);
 767
 768 /* vtbl.c */
 769 int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
 770                            struct ubi_vtbl_record *vtbl_rec);
 771 int ubi_vtbl_rename_volumes(struct ubi_device *ubi,
 772                             struct list_head *rename_list);
 773 int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_attach_info *ai);
 774
 775 /* vmt.c */
 776 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req);
 777 int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl);
 778 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs);
 779 int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list);
 780 int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol);
 781 void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol);
 782
 783 /* upd.c */
 784 int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol,
 785                      long long bytes);
 786 int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol,
 787                          const void __user *buf, int count);
 788 int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
 789                          const struct ubi_leb_change_req *req);
 790 int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol,
 791                              const void __user *buf, int count);
 792
 793 /* misc.c */
 794 int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf,
 795                       int length);
 796 int ubi_check_volume(struct ubi_device *ubi, int vol_id);
 797 void ubi_update_reserved(struct ubi_device *ubi);
 798 void ubi_calculate_reserved(struct ubi_device *ubi);
 799 int ubi_check_pattern(const void *buf, uint8_t patt, int size);
 800
 801 /* eba.c */
 802 int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
 803                       int lnum);
 804 int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 805                      void *buf, int offset, int len, int check);
 806 int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
 807                         struct ubi_sgl *sgl, int lnum, int offset, int len,
 808                         int check);
 809 int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 810                       const void *buf, int offset, int len);
 811 int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
 812                          int lnum, const void *buf, int len, int used_ebs);
 813 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
 814                               int lnum, const void *buf, int len);
 815 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
 816                      struct ubi_vid_hdr *vid_hdr);
 817 int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
 818 unsigned long long ubi_next_sqnum(struct ubi_device *ubi);
 819 int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
 820                    struct ubi_attach_info *ai_scan);
 821
 822 /* wl.c */
 823 int ubi_wl_get_peb(struct ubi_device *ubi);
 824 int ubi_wl_put_peb(struct ubi_device *ubi, int vol_id, int lnum,
 825                    int pnum, int torture);
 826 int ubi_wl_flush(struct ubi_device *ubi, int vol_id, int lnum);
 827 int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum);
 828 int ubi_wl_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
 829 void ubi_wl_close(struct ubi_device *ubi);
 830 int ubi_thread(void *u);
 831 struct ubi_wl_entry *ubi_wl_get_fm_peb(struct ubi_device *ubi, int anchor);
 832 int ubi_wl_put_fm_peb(struct ubi_device *ubi, struct ubi_wl_entry *used_e,
 833                       int lnum, int torture);
 834 int ubi_is_erase_work(struct ubi_work *wrk);
 835 void ubi_refill_pools(struct ubi_device *ubi);
 836 int ubi_ensure_anchor_pebs(struct ubi_device *ubi);
 837
 838 /* io.c */
 839 int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
 840                 int len);
 841 int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
 842                  int len);
 843 int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture);
 844 int ubi_io_is_bad(const struct ubi_device *ubi, int pnum);
 845 int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum);
 846 int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
 847                        struct ubi_ec_hdr *ec_hdr, int verbose);
 848 int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
 849                         struct ubi_ec_hdr *ec_hdr);
 850 int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
 851                         struct ubi_vid_hdr *vid_hdr, int verbose);
 852 int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
 853                          struct ubi_vid_hdr *vid_hdr);
 854
 855 /* build.c */
 856 int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,
 857                        int vid_hdr_offset, int max_beb_per1024);
 858 int ubi_detach_mtd_dev(int ubi_num, int anyway);
 859 struct ubi_device *ubi_get_device(int ubi_num);
 860 void ubi_put_device(struct ubi_device *ubi);
 861 struct ubi_device *ubi_get_by_major(int major);
 862 int ubi_major2num(int major);
 863 int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol,
 864                       int ntype);
 865 int ubi_notify_all(struct ubi_device *ubi, int ntype,
 866                    struct notifier_block *nb);
 867 int ubi_enumerate_volumes(struct notifier_block *nb);
 868 void ubi_free_internal_volumes(struct ubi_device *ubi);
 869
 870 /* kapi.c */
 871 void ubi_do_get_device_info(struct ubi_device *ubi, struct ubi_device_info *di);
 872 void ubi_do_get_volume_info(struct ubi_device *ubi, struct ubi_volume *vol,
 873                             struct ubi_volume_info *vi);
 874 /* scan.c */
 875 int ubi_compare_lebs(struct ubi_device *ubi, const struct ubi_ainf_peb *aeb,
 876                       int pnum, const struct ubi_vid_hdr *vid_hdr);
 877
 878 /* fastmap.c */
 879 #ifdef CONFIG_MTD_UBI_FASTMAP
 880 size_t ubi_calc_fm_size(struct ubi_device *ubi);
 881 int ubi_update_fastmap(struct ubi_device *ubi);
 882 int ubi_scan_fastmap(struct ubi_device *ubi, struct ubi_attach_info *ai,
 883                      int fm_anchor);
 884 #else
 885 static inline int ubi_update_fastmap(struct ubi_device *ubi) { return 0; }
 886 #endif
 887
 888 /* block.c */
 889 #ifdef CONFIG_MTD_UBI_BLOCK
 890 int ubiblock_init(void);
 891 void ubiblock_exit(void);
 892 int ubiblock_create(struct ubi_volume_info *vi);
 893 int ubiblock_remove(struct ubi_volume_info *vi);
 894 #else
 895 static inline int ubiblock_init(void) { return 0; }
 896 static inline void ubiblock_exit(void) {}
 897 static inline int ubiblock_create(struct ubi_volume_info *vi)
 898 {
 899         return -ENOSYS;
 900 }
 901 static inline int ubiblock_remove(struct ubi_volume_info *vi)
 902 {
 903         return -ENOSYS;
 904 }
 905 #endif
 906
 907 /*
 908  * ubi_for_each_free_peb - walk the UBI free RB tree.
 909  * @ubi: UBI device description object
 910  * @e: a pointer to a ubi_wl_entry to use as cursor
 911  * @pos: a pointer to RB-tree entry type to use as a loop counter
 912  */
 913 #define ubi_for_each_free_peb(ubi, e, tmp_rb)   \
 914         ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->free, u.rb)
 915
 916 /*
 917  * ubi_for_each_used_peb - walk the UBI used RB tree.
 918  * @ubi: UBI device description object
 919  * @e: a pointer to a ubi_wl_entry to use as cursor
 920  * @pos: a pointer to RB-tree entry type to use as a loop counter
 921  */
 922 #define ubi_for_each_used_peb(ubi, e, tmp_rb)   \
 923         ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->used, u.rb)
 924
 925 /*
 926  * ubi_for_each_scub_peb - walk the UBI scub RB tree.
 927  * @ubi: UBI device description object
 928  * @e: a pointer to a ubi_wl_entry to use as cursor
 929  * @pos: a pointer to RB-tree entry type to use as a loop counter
 930  */
 931 #define ubi_for_each_scrub_peb(ubi, e, tmp_rb)  \
 932         ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->scrub, u.rb)
 933
 934 /*
 935  * ubi_for_each_protected_peb - walk the UBI protection queue.
 936  * @ubi: UBI device description object
 937  * @i: a integer used as counter
 938  * @e: a pointer to a ubi_wl_entry to use as cursor
 939  */
 940 #define ubi_for_each_protected_peb(ubi, i, e)   \
 941         for ((i) = 0; (i) < UBI_PROT_QUEUE_LEN; (i)++)  \
 942                 list_for_each_entry((e), &(ubi->pq[(i)]), u.list)
 943
 944 /*
 945  * ubi_rb_for_each_entry - walk an RB-tree.
 946  * @rb: a pointer to type 'struct rb_node' to use as a loop counter
 947  * @pos: a pointer to RB-tree entry type to use as a loop counter
 948  * @root: RB-tree's root
 949  * @member: the name of the 'struct rb_node' within the RB-tree entry
 950  */
 951 #define ubi_rb_for_each_entry(rb, pos, root, member)                         \
 952         for (rb = rb_first(root),                                            \
 953              pos = (rb ? container_of(rb, typeof(*pos), member) : NULL);     \
 954              rb;                                                             \
 955              rb = rb_next(rb),                                               \
 956              pos = (rb ? container_of(rb, typeof(*pos), member) : NULL))
 957
 958 /*
 959  * ubi_move_aeb_to_list - move a PEB from the volume tree to a list.
 960  *
 961  * @av: volume attaching information
 962  * @aeb: attaching eraseblock information
 963  * @list: the list to move to
 964  */
 965 static inline void ubi_move_aeb_to_list(struct ubi_ainf_volume *av,
 966                                          struct ubi_ainf_peb *aeb,
 967                                          struct list_head *list)
 968 {
 969                 rb_erase(&aeb->u.rb, &av->root);
 970                 list_add_tail(&aeb->u.list, list);
 971 }
 972
 973 /**
 974  * ubi_zalloc_vid_hdr - allocate a volume identifier header object.
 975  * @ubi: UBI device description object
 976  * @gfp_flags: GFP flags to allocate with
 977  *
 978  * This function returns a pointer to the newly allocated and zero-filled
 979  * volume identifier header object in case of success and %NULL in case of
 980  * failure.
 981  */
 982 static inline struct ubi_vid_hdr *
 983 ubi_zalloc_vid_hdr(const struct ubi_device *ubi, gfp_t gfp_flags)
 984 {
 985         void *vid_hdr;
 986
 987         vid_hdr = kzalloc(ubi->vid_hdr_alsize, gfp_flags);
 988         if (!vid_hdr)
 989                 return NULL;
 990
 991         /*
 992          * VID headers may be stored at un-aligned flash offsets, so we shift
 993          * the pointer.
 994          */
 995         return vid_hdr + ubi->vid_hdr_shift;
 996 }
 997
 998 /**
 999  * ubi_free_vid_hdr - free a volume identifier header object.
1000  * @ubi: UBI device description object
1001  * @vid_hdr: the object to free
1002  */
1003 static inline void ubi_free_vid_hdr(const struct ubi_device *ubi,
1004                                     struct ubi_vid_hdr *vid_hdr)
1005 {
1006         void *p = vid_hdr;
1007
1008         if (!p)
1009                 return;
1010
1011         kfree(p - ubi->vid_hdr_shift);
1012 }
1013
1014 /*
1015  * This function is equivalent to 'ubi_io_read()', but @offset is relative to
1016  * the beginning of the logical eraseblock, not to the beginning of the
1017  * physical eraseblock.
1018  */
1019 static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf,
1020                                    int pnum, int offset, int len)
1021 {
1022         ubi_assert(offset >= 0);
1023         return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len);
1024 }
1025
1026 /*
1027  * This function is equivalent to 'ubi_io_write()', but @offset is relative to
1028  * the beginning of the logical eraseblock, not to the beginning of the
1029  * physical eraseblock.
1030  */
1031 static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf,
1032                                     int pnum, int offset, int len)
1033 {
1034         ubi_assert(offset >= 0);
1035         return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len);
1036 }
1037
1038 /**
1039  * ubi_ro_mode - switch to read-only mode.
1040  * @ubi: UBI device description object
1041  */
1042 static inline void ubi_ro_mode(struct ubi_device *ubi)
1043 {
1044         if (!ubi->ro_mode) {
1045                 ubi->ro_mode = 1;
1046                 ubi_warn(ubi, "switch to read-only mode");
1047                 dump_stack();
1048         }
1049 }
1050
1051 /**
1052  * vol_id2idx - get table index by volume ID.
1053  * @ubi: UBI device description object
1054  * @vol_id: volume ID
1055  */
1056 static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id)
1057 {
1058         if (vol_id >= UBI_INTERNAL_VOL_START)
1059                 return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots;
1060         else
1061                 return vol_id;
1062 }
1063
1064 /**
1065  * idx2vol_id - get volume ID by table index.
1066  * @ubi: UBI device description object
1067  * @idx: table index
1068  */
1069 static inline int idx2vol_id(const struct ubi_device *ubi, int idx)
1070 {
1071         if (idx >= ubi->vtbl_slots)
1072                 return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START;
1073         else
1074                 return idx;
1075 }
1076
1077 #endif /* !__UBI_UBI_H__ */