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