drivers/mtd/ubi/ubi.h

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