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