drivers/mtd/ubi/ubi.h

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