drivers/mtd/ubi/ubi.h

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