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/string.h>
  38 #include <linux/vmalloc.h>
  39 #include <linux/mtd/mtd.h>
  40 #include <linux/mtd/ubi.h>
  41
  42 #include "ubi-media.h"
  43 #include "scan.h"
  44 #include "debug.h"
  45
  46 /* Maximum number of supported UBI devices */
  47 #define UBI_MAX_DEVICES 32
  48
  49 /* UBI name used for character devices, sysfs, etc */
  50 #define UBI_NAME_STR "ubi"
  51
  52 /* Normal UBI messages */
  53 #define ubi_msg(fmt, ...) printk(KERN_NOTICE "UBI: " fmt "\n", ##__VA_ARGS__)
  54 /* UBI warning messages */
  55 #define ubi_warn(fmt, ...) printk(KERN_WARNING "UBI warning: %s: " fmt "\n", \
  56                                   __func__, ##__VA_ARGS__)
  57 /* UBI error messages */
  58 #define ubi_err(fmt, ...) printk(KERN_ERR "UBI error: %s: " fmt "\n", \
  59                                  __func__, ##__VA_ARGS__)
  60
  61 /* Lowest number PEBs reserved for bad PEB handling */
  62 #define MIN_RESEVED_PEBS 2
  63
  64 /* Background thread name pattern */
  65 #define UBI_BGT_NAME_PATTERN "ubi_bgt%dd"
  66
  67 /* This marker in the EBA table means that the LEB is um-mapped */
  68 #define UBI_LEB_UNMAPPED -1
  69
  70 /*
  71  * In case of errors, UBI tries to repeat the operation several times before
  72  * returning error. The below constant defines how many times UBI re-tries.
  73  */
  74 #define UBI_IO_RETRIES 3
  75
  76 /*
  77  * Length of the protection queue. The length is effectively equivalent to the
  78  * number of (global) erase cycles PEBs are protected from the wear-leveling
  79  * worker.
  80  */
  81 #define UBI_PROT_QUEUE_LEN 10
  82
  83 /*
  84  * Error codes returned by the I/O sub-system.
  85  *
  86  * UBI_IO_PEB_EMPTY: the physical eraseblock is empty, i.e. it contains only
  87  *                   %0xFF bytes
  88  * UBI_IO_PEB_FREE: the physical eraseblock is free, i.e. it contains only a
  89  *                  valid erase counter header, and the rest are %0xFF bytes
  90  * UBI_IO_BAD_EC_HDR: the erase counter header is corrupted (bad magic or CRC)
  91  * UBI_IO_BAD_VID_HDR: the volume identifier header is corrupted (bad magic or
  92  *                     CRC)
  93  * UBI_IO_BITFLIPS: bit-flips were detected and corrected
  94  */
  95 enum {
  96         UBI_IO_PEB_EMPTY = 1,
  97         UBI_IO_PEB_FREE,
  98         UBI_IO_BAD_EC_HDR,
  99         UBI_IO_BAD_VID_HDR,
 100         UBI_IO_BITFLIPS
 101 };
 102
 103 /*
 104  * Return codes of the 'ubi_eba_copy_leb()' function.
 105  *
 106  * MOVE_CANCEL_RACE: canceled because the volume is being deleted, the source
 107  *                   PEB was put meanwhile, or there is I/O on the source PEB
 108  * MOVE_SOURCE_RD_ERR: canceled because there was a read error from the source
 109  *                     PEB
 110  * MOVE_TARGET_RD_ERR: canceled because there was a read error from the target
 111  *                     PEB
 112  * MOVE_TARGET_WR_ERR: canceled because there was a write error to the target
 113  *                     PEB
 114  * MOVE_CANCEL_BITFLIPS: canceled because a bit-flip was detected in the
 115  *                       target PEB
 116  */
 117 enum {
 118         MOVE_CANCEL_RACE = 1,
 119         MOVE_SOURCE_RD_ERR,
 120         MOVE_TARGET_RD_ERR,
 121         MOVE_TARGET_WR_ERR,
 122         MOVE_CANCEL_BITFLIPS,
 123 };
 124
 125 /**
 126  * struct ubi_wl_entry - wear-leveling entry.
 127  * @u.rb: link in the corresponding (free/used) RB-tree
 128  * @u.list: link in the protection queue
 129  * @ec: erase counter
 130  * @pnum: physical eraseblock number
 131  *
 132  * This data structure is used in the WL sub-system. Each physical eraseblock
 133  * has a corresponding &struct wl_entry object which may be kept in different
 134  * RB-trees. See WL sub-system for details.
 135  */
 136 struct ubi_wl_entry {
 137         union {
 138                 struct rb_node rb;
 139                 struct list_head list;
 140         } u;
 141         int ec;
 142         int pnum;
 143 };
 144
 145 /**
 146  * struct ubi_ltree_entry - an entry in the lock tree.
 147  * @rb: links RB-tree nodes
 148  * @vol_id: volume ID of the locked logical eraseblock
 149  * @lnum: locked logical eraseblock number
 150  * @users: how many tasks are using this logical eraseblock or wait for it
 151  * @mutex: read/write mutex to implement read/write access serialization to
 152  *         the (@vol_id, @lnum) logical eraseblock
 153  *
 154  * This data structure is used in the EBA sub-system to implement per-LEB
 155  * locking. When a logical eraseblock is being locked - corresponding
 156  * &struct ubi_ltree_entry object is inserted to the lock tree (@ubi->ltree).
 157  * See EBA sub-system for details.
 158  */
 159 struct ubi_ltree_entry {
 160         struct rb_node rb;
 161         int vol_id;
 162         int lnum;
 163         int users;
 164         struct rw_semaphore mutex;
 165 };
 166
 167 /**
 168  * struct ubi_rename_entry - volume re-name description data structure.
 169  * @new_name_len: new volume name length
 170  * @new_name: new volume name
 171  * @remove: if not zero, this volume should be removed, not re-named
 172  * @desc: descriptor of the volume
 173  * @list: links re-name entries into a list
 174  *
 175  * This data structure is utilized in the multiple volume re-name code. Namely,
 176  * UBI first creates a list of &struct ubi_rename_entry objects from the
 177  * &struct ubi_rnvol_req request object, and then utilizes this list to do all
 178  * the job.
 179  */
 180 struct ubi_rename_entry {
 181         int new_name_len;
 182         char new_name[UBI_VOL_NAME_MAX + 1];
 183         int remove;
 184         struct ubi_volume_desc *desc;
 185         struct list_head list;
 186 };
 187
 188 struct ubi_volume_desc;
 189
 190 /**
 191  * struct ubi_volume - UBI volume description data structure.
 192  * @dev: device object to make use of the the Linux device model
 193  * @cdev: character device object to create character device
 194  * @ubi: reference to the UBI device description object
 195  * @vol_id: volume ID
 196  * @ref_count: volume reference count
 197  * @readers: number of users holding this volume in read-only mode
 198  * @writers: number of users holding this volume in read-write mode
 199  * @exclusive: whether somebody holds this volume in exclusive mode
 200  *
 201  * @reserved_pebs: how many physical eraseblocks are reserved for this volume
 202  * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
 203  * @usable_leb_size: logical eraseblock size without padding
 204  * @used_ebs: how many logical eraseblocks in this volume contain data
 205  * @last_eb_bytes: how many bytes are stored in the last logical eraseblock
 206  * @used_bytes: how many bytes of data this volume contains
 207  * @alignment: volume alignment
 208  * @data_pad: how many bytes are not used at the end of physical eraseblocks to
 209  *            satisfy the requested alignment
 210  * @name_len: volume name length
 211  * @name: volume name
 212  *
 213  * @upd_ebs: how many eraseblocks are expected to be updated
 214  * @ch_lnum: LEB number which is being changing by the atomic LEB change
 215  *           operation
 216  * @ch_dtype: data persistency type which is being changing by the atomic LEB
 217  *            change operation
 218  * @upd_bytes: how many bytes are expected to be received for volume update or
 219  *             atomic LEB change
 220  * @upd_received: how many bytes were already received for volume update or
 221  *                atomic LEB change
 222  * @upd_buf: update buffer which is used to collect update data or data for
 223  *           atomic LEB change
 224  *
 225  * @eba_tbl: EBA table of this volume (LEB->PEB mapping)
 226  * @checked: %1 if this static volume was checked
 227  * @corrupted: %1 if the volume is corrupted (static volumes only)
 228  * @upd_marker: %1 if the update marker is set for this volume
 229  * @updating: %1 if the volume is being updated
 230  * @changing_leb: %1 if the atomic LEB change ioctl command is in progress
 231  * @direct_writes: %1 if direct writes are enabled for this volume
 232  *
 233  * @gluebi_desc: gluebi UBI volume descriptor
 234  * @gluebi_refcount: reference count of the gluebi MTD device
 235  * @gluebi_mtd: MTD device description object of the gluebi MTD device
 236  *
 237  * The @corrupted field indicates that the volume's contents is corrupted.
 238  * Since UBI protects only static volumes, this field is not relevant to
 239  * dynamic volumes - it is user's responsibility to assure their data
 240  * integrity.
 241  *
 242  * The @upd_marker flag indicates that this volume is either being updated at
 243  * the moment or is damaged because of an unclean reboot.
 244  */
 245 struct ubi_volume {
 246         struct device dev;
 247         struct cdev cdev;
 248         struct ubi_device *ubi;
 249         int vol_id;
 250         int ref_count;
 251         int readers;
 252         int writers;
 253         int exclusive;
 254
 255         int reserved_pebs;
 256         int vol_type;
 257         int usable_leb_size;
 258         int used_ebs;
 259         int last_eb_bytes;
 260         long long used_bytes;
 261         int alignment;
 262         int data_pad;
 263         int name_len;
 264         char name[UBI_VOL_NAME_MAX + 1];
 265
 266         int upd_ebs;
 267         int ch_lnum;
 268         int ch_dtype;
 269         long long upd_bytes;
 270         long long upd_received;
 271         void *upd_buf;
 272
 273         int *eba_tbl;
 274         unsigned int checked:1;
 275         unsigned int corrupted:1;
 276         unsigned int upd_marker:1;
 277         unsigned int updating:1;
 278         unsigned int changing_leb:1;
 279         unsigned int direct_writes:1;
 280
 281 #ifdef CONFIG_MTD_UBI_GLUEBI
 282         /*
 283          * Gluebi-related stuff may be compiled out.
 284          * Note: this should not be built into UBI but should be a separate
 285          * ubimtd driver which works on top of UBI and emulates MTD devices.
 286          */
 287         struct ubi_volume_desc *gluebi_desc;
 288         int gluebi_refcount;
 289         struct mtd_info gluebi_mtd;
 290 #endif
 291 };
 292
 293 /**
 294  * struct ubi_volume_desc - UBI volume descriptor returned when it is opened.
 295  * @vol: reference to the corresponding volume description object
 296  * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, or %UBI_EXCLUSIVE)
 297  */
 298 struct ubi_volume_desc {
 299         struct ubi_volume *vol;
 300         int mode;
 301 };
 302
 303 struct ubi_wl_entry;
 304
 305 /**
 306  * struct ubi_device - UBI device description structure
 307  * @dev: UBI device object to use the the Linux device model
 308  * @cdev: character device object to create character device
 309  * @ubi_num: UBI device number
 310  * @ubi_name: UBI device name
 311  * @vol_count: number of volumes in this UBI device
 312  * @volumes: volumes of this UBI device
 313  * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs,
 314  *                @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count,
 315  *                @vol->readers, @vol->writers, @vol->exclusive,
 316  *                @vol->ref_count, @vol->mapping and @vol->eba_tbl.
 317  * @ref_count: count of references on the UBI device
 318  *
 319  * @rsvd_pebs: count of reserved physical eraseblocks
 320  * @avail_pebs: count of available physical eraseblocks
 321  * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB
 322  *                 handling
 323  * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling
 324  *
 325  * @autoresize_vol_id: ID of the volume which has to be auto-resized at the end
 326  *                     of UBI initialization
 327  * @vtbl_slots: how many slots are available in the volume table
 328  * @vtbl_size: size of the volume table in bytes
 329  * @vtbl: in-RAM volume table copy
 330  * @device_mutex: protects on-flash volume table and serializes volume
 331  *                creation, deletion, update, re-size, re-name and set
 332  *                property
 333  *
 334  * @max_ec: current highest erase counter value
 335  * @mean_ec: current mean erase counter value
 336  *
 337  * @global_sqnum: global sequence number
 338  * @ltree_lock: protects the lock tree and @global_sqnum
 339  * @ltree: the lock tree
 340  * @alc_mutex: serializes "atomic LEB change" operations
 341  *
 342  * @used: RB-tree of used physical eraseblocks
 343  * @erroneous: RB-tree of erroneous used physical eraseblocks
 344  * @free: RB-tree of free physical eraseblocks
 345  * @scrub: RB-tree of physical eraseblocks which need scrubbing
 346  * @pq: protection queue (contain physical eraseblocks which are temporarily
 347  *      protected from the wear-leveling worker)
 348  * @pq_head: protection queue head
 349  * @wl_lock: protects the @used, @free, @pq, @pq_head, @lookuptbl, @move_from,
 350  *           @move_to, @move_to_put @erase_pending, @wl_scheduled, @works and
 351  *           @erroneous_peb_count fields
 352  * @move_mutex: serializes eraseblock moves
 353  * @work_sem: synchronizes the WL worker with use tasks
 354  * @wl_scheduled: non-zero if the wear-leveling was scheduled
 355  * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
 356  *             physical eraseblock
 357  * @move_from: physical eraseblock from where the data is being moved
 358  * @move_to: physical eraseblock where the data is being moved to
 359  * @move_to_put: if the "to" PEB was put
 360  * @works: list of pending works
 361  * @works_count: count of pending works
 362  * @bgt_thread: background thread description object
 363  * @thread_enabled: if the background thread is enabled
 364  * @bgt_name: background thread name
 365  *
 366  * @flash_size: underlying MTD device size (in bytes)
 367  * @peb_count: count of physical eraseblocks on the MTD device
 368  * @peb_size: physical eraseblock size
 369  * @bad_peb_count: count of bad physical eraseblocks
 370  * @good_peb_count: count of good physical eraseblocks
 371  * @erroneous_peb_count: count of erroneous physical eraseblocks in @erroneous
 372  * @max_erroneous: maximum allowed amount of erroneous physical eraseblocks
 373  * @min_io_size: minimal input/output unit size of the underlying MTD device
 374  * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers
 375  * @ro_mode: if the UBI device is in read-only mode
 376  * @leb_size: logical eraseblock size
 377  * @leb_start: starting offset of logical eraseblocks within physical
 378  *             eraseblocks
 379  * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size
 380  * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size
 381  * @vid_hdr_offset: starting offset of the volume identifier header (might be
 382  *                  unaligned)
 383  * @vid_hdr_aloffset: starting offset of the VID header aligned to
 384  * @hdrs_min_io_size
 385  * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset
 386  * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or
 387  *               not
 388  * @mtd: MTD device descriptor
 389  *
 390  * @peb_buf1: a buffer of PEB size used for different purposes
 391  * @peb_buf2: another buffer of PEB size used for different purposes
 392  * @buf_mutex: protects @peb_buf1 and @peb_buf2
 393  * @ckvol_mutex: serializes static volume checking when opening
 394  * @dbg_peb_buf: buffer of PEB size used for debugging
 395  * @dbg_buf_mutex: protects @dbg_peb_buf
 396  */
 397 struct ubi_device {
 398         struct cdev cdev;
 399         struct device dev;
 400         int ubi_num;
 401         char ubi_name[sizeof(UBI_NAME_STR)+5];
 402         int vol_count;
 403         struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT];
 404         spinlock_t volumes_lock;
 405         int ref_count;
 406
 407         int rsvd_pebs;
 408         int avail_pebs;
 409         int beb_rsvd_pebs;
 410         int beb_rsvd_level;
 411
 412         int autoresize_vol_id;
 413         int vtbl_slots;
 414         int vtbl_size;
 415         struct ubi_vtbl_record *vtbl;
 416         struct mutex device_mutex;
 417
 418         int max_ec;
 419         /* Note, mean_ec is not updated run-time - should be fixed */
 420         int mean_ec;
 421
 422         /* EBA sub-system's stuff */
 423         unsigned long long global_sqnum;
 424         spinlock_t ltree_lock;
 425         struct rb_root ltree;
 426         struct mutex alc_mutex;
 427
 428         /* Wear-leveling sub-system's stuff */
 429         struct rb_root used;
 430         struct rb_root erroneous;
 431         struct rb_root free;
 432         struct rb_root scrub;
 433         struct list_head pq[UBI_PROT_QUEUE_LEN];
 434         int pq_head;
 435         spinlock_t wl_lock;
 436         struct mutex move_mutex;
 437         struct rw_semaphore work_sem;
 438         int wl_scheduled;
 439         struct ubi_wl_entry **lookuptbl;
 440         struct ubi_wl_entry *move_from;
 441         struct ubi_wl_entry *move_to;
 442         int move_to_put;
 443         struct list_head works;
 444         int works_count;
 445         struct task_struct *bgt_thread;
 446         int thread_enabled;
 447         char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2];
 448
 449         /* I/O sub-system's stuff */
 450         long long flash_size;
 451         int peb_count;
 452         int peb_size;
 453         int bad_peb_count;
 454         int good_peb_count;
 455         int erroneous_peb_count;
 456         int max_erroneous;
 457         int min_io_size;
 458         int hdrs_min_io_size;
 459         int ro_mode;
 460         int leb_size;
 461         int leb_start;
 462         int ec_hdr_alsize;
 463         int vid_hdr_alsize;
 464         int vid_hdr_offset;
 465         int vid_hdr_aloffset;
 466         int vid_hdr_shift;
 467         int bad_allowed;
 468         struct mtd_info *mtd;
 469
 470         void *peb_buf1;
 471         void *peb_buf2;
 472         struct mutex buf_mutex;
 473         struct mutex ckvol_mutex;
 474 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
 475         void *dbg_peb_buf;
 476         struct mutex dbg_buf_mutex;
 477 #endif
 478 };
 479
 480 extern struct kmem_cache *ubi_wl_entry_slab;
 481 extern const struct file_operations ubi_ctrl_cdev_operations;
 482 extern const struct file_operations ubi_cdev_operations;
 483 extern const struct file_operations ubi_vol_cdev_operations;
 484 extern struct class *ubi_class;
 485 extern struct mutex ubi_devices_mutex;
 486
 487 /* vtbl.c */
 488 int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
 489                            struct ubi_vtbl_record *vtbl_rec);
 490 int ubi_vtbl_rename_volumes(struct ubi_device *ubi,
 491                             struct list_head *rename_list);
 492 int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_scan_info *si);
 493
 494 /* vmt.c */
 495 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req);
 496 int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl);
 497 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs);
 498 int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list);
 499 int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol);
 500 void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol);
 501
 502 /* upd.c */
 503 int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol,
 504                      long long bytes);
 505 int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol,
 506                          const void __user *buf, int count);
 507 int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
 508                          const struct ubi_leb_change_req *req);
 509 int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol,
 510                              const void __user *buf, int count);
 511
 512 /* misc.c */
 513 int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf,
 514                       int length);
 515 int ubi_check_volume(struct ubi_device *ubi, int vol_id);
 516 void ubi_calculate_reserved(struct ubi_device *ubi);
 517
 518 /* gluebi.c */
 519 #ifdef CONFIG_MTD_UBI_GLUEBI
 520 int ubi_create_gluebi(struct ubi_device *ubi, struct ubi_volume *vol);
 521 int ubi_destroy_gluebi(struct ubi_volume *vol);
 522 void ubi_gluebi_updated(struct ubi_volume *vol);
 523 #else
 524 #define ubi_create_gluebi(ubi, vol) 0
 525 #define ubi_destroy_gluebi(vol) 0
 526 #define ubi_gluebi_updated(vol)
 527 #endif
 528
 529 /* eba.c */
 530 int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
 531                       int lnum);
 532 int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 533                      void *buf, int offset, int len, int check);
 534 int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 535                       const void *buf, int offset, int len, int dtype);
 536 int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
 537                          int lnum, const void *buf, int len, int dtype,
 538                          int used_ebs);
 539 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
 540                               int lnum, const void *buf, int len, int dtype);
 541 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
 542                      struct ubi_vid_hdr *vid_hdr);
 543 int ubi_eba_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si);
 544
 545 /* wl.c */
 546 int ubi_wl_get_peb(struct ubi_device *ubi, int dtype);
 547 int ubi_wl_put_peb(struct ubi_device *ubi, int pnum, int torture);
 548 int ubi_wl_flush(struct ubi_device *ubi);
 549 int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum);
 550 int ubi_wl_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si);
 551 void ubi_wl_close(struct ubi_device *ubi);
 552 int ubi_thread(void *u);
 553
 554 /* io.c */
 555 int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
 556                 int len);
 557 int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
 558                  int len);
 559 int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture);
 560 int ubi_io_is_bad(const struct ubi_device *ubi, int pnum);
 561 int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum);
 562 int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
 563                        struct ubi_ec_hdr *ec_hdr, int verbose);
 564 int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
 565                         struct ubi_ec_hdr *ec_hdr);
 566 int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
 567                         struct ubi_vid_hdr *vid_hdr, int verbose);
 568 int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
 569                          struct ubi_vid_hdr *vid_hdr);
 570
 571 /* build.c */
 572 int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset);
 573 int ubi_detach_mtd_dev(int ubi_num, int anyway);
 574 struct ubi_device *ubi_get_device(int ubi_num);
 575 void ubi_put_device(struct ubi_device *ubi);
 576 struct ubi_device *ubi_get_by_major(int major);
 577 int ubi_major2num(int major);
 578
 579 /*
 580  * ubi_rb_for_each_entry - walk an RB-tree.
 581  * @rb: a pointer to type 'struct rb_node' to to use as a loop counter
 582  * @pos: a pointer to RB-tree entry type to use as a loop counter
 583  * @root: RB-tree's root
 584  * @member: the name of the 'struct rb_node' within the RB-tree entry
 585  */
 586 #define ubi_rb_for_each_entry(rb, pos, root, member)                         \
 587         for (rb = rb_first(root),                                            \
 588              pos = (rb ? container_of(rb, typeof(*pos), member) : NULL);     \
 589              rb;                                                             \
 590              rb = rb_next(rb), pos = container_of(rb, typeof(*pos), member))
 591
 592 /**
 593  * ubi_zalloc_vid_hdr - allocate a volume identifier header object.
 594  * @ubi: UBI device description object
 595  * @gfp_flags: GFP flags to allocate with
 596  *
 597  * This function returns a pointer to the newly allocated and zero-filled
 598  * volume identifier header object in case of success and %NULL in case of
 599  * failure.
 600  */
 601 static inline struct ubi_vid_hdr *
 602 ubi_zalloc_vid_hdr(const struct ubi_device *ubi, gfp_t gfp_flags)
 603 {
 604         void *vid_hdr;
 605
 606         vid_hdr = kzalloc(ubi->vid_hdr_alsize, gfp_flags);
 607         if (!vid_hdr)
 608                 return NULL;
 609
 610         /*
 611          * VID headers may be stored at un-aligned flash offsets, so we shift
 612          * the pointer.
 613          */
 614         return vid_hdr + ubi->vid_hdr_shift;
 615 }
 616
 617 /**
 618  * ubi_free_vid_hdr - free a volume identifier header object.
 619  * @ubi: UBI device description object
 620  * @vid_hdr: the object to free
 621  */
 622 static inline void ubi_free_vid_hdr(const struct ubi_device *ubi,
 623                                     struct ubi_vid_hdr *vid_hdr)
 624 {
 625         void *p = vid_hdr;
 626
 627         if (!p)
 628                 return;
 629
 630         kfree(p - ubi->vid_hdr_shift);
 631 }
 632
 633 /*
 634  * This function is equivalent to 'ubi_io_read()', but @offset is relative to
 635  * the beginning of the logical eraseblock, not to the beginning of the
 636  * physical eraseblock.
 637  */
 638 static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf,
 639                                    int pnum, int offset, int len)
 640 {
 641         ubi_assert(offset >= 0);
 642         return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len);
 643 }
 644
 645 /*
 646  * This function is equivalent to 'ubi_io_write()', but @offset is relative to
 647  * the beginning of the logical eraseblock, not to the beginning of the
 648  * physical eraseblock.
 649  */
 650 static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf,
 651                                     int pnum, int offset, int len)
 652 {
 653         ubi_assert(offset >= 0);
 654         return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len);
 655 }
 656
 657 /**
 658  * ubi_ro_mode - switch to read-only mode.
 659  * @ubi: UBI device description object
 660  */
 661 static inline void ubi_ro_mode(struct ubi_device *ubi)
 662 {
 663         if (!ubi->ro_mode) {
 664                 ubi->ro_mode = 1;
 665                 ubi_warn("switch to read-only mode");
 666         }
 667 }
 668
 669 /**
 670  * vol_id2idx - get table index by volume ID.
 671  * @ubi: UBI device description object
 672  * @vol_id: volume ID
 673  */
 674 static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id)
 675 {
 676         if (vol_id >= UBI_INTERNAL_VOL_START)
 677                 return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots;
 678         else
 679                 return vol_id;
 680 }
 681
 682 /**
 683  * idx2vol_id - get volume ID by table index.
 684  * @ubi: UBI device description object
 685  * @idx: table index
 686  */
 687 static inline int idx2vol_id(const struct ubi_device *ubi, int idx)
 688 {
 689         if (idx >= ubi->vtbl_slots)
 690                 return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START;
 691         else
 692                 return idx;
 693 }
 694
 695 #endif /* !__UBI_UBI_H__ */