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