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
  41 #include <mtd/ubi-header.h>
  42 #include <linux/mtd/ubi.h>
  43
  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                                   __FUNCTION__, ##__VA_ARGS__)
  58 /* UBI error messages */
  59 #define ubi_err(fmt, ...) printk(KERN_ERR "UBI error: %s: " fmt "\n", \
  60                                  __FUNCTION__, ##__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  * Error codes returned by the I/O unit.
  79  *
  80  * UBI_IO_PEB_EMPTY: the physical eraseblock is empty, i.e. it contains only
  81  * 0xFF bytes
  82  * UBI_IO_PEB_FREE: the physical eraseblock is free, i.e. it contains only a
  83  * valid erase counter header, and the rest are %0xFF bytes
  84  * UBI_IO_BAD_EC_HDR: the erase counter header is corrupted (bad magic or CRC)
  85  * UBI_IO_BAD_VID_HDR: the volume identifier header is corrupted (bad magic or
  86  * CRC)
  87  * UBI_IO_BITFLIPS: bit-flips were detected and corrected
  88  */
  89 enum {
  90         UBI_IO_PEB_EMPTY = 1,
  91         UBI_IO_PEB_FREE,
  92         UBI_IO_BAD_EC_HDR,
  93         UBI_IO_BAD_VID_HDR,
  94         UBI_IO_BITFLIPS
  95 };
  96
  97 extern int ubi_devices_cnt;
  98 extern struct ubi_device *ubi_devices[];
  99
 100 struct ubi_volume_desc;
 101
 102 /**
 103  * struct ubi_volume - UBI volume description data structure.
 104  * @dev: device object to make use of the the Linux device model
 105  * @cdev: character device object to create character device
 106  * @ubi: reference to the UBI device description object
 107  * @vol_id: volume ID
 108  * @readers: number of users holding this volume in read-only mode
 109  * @writers: number of users holding this volume in read-write mode
 110  * @exclusive: whether somebody holds this volume in exclusive mode
 111  * @removed: if the volume was removed
 112  * @checked: if this static volume was checked
 113  *
 114  * @reserved_pebs: how many physical eraseblocks are reserved for this volume
 115  * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
 116  * @usable_leb_size: logical eraseblock size without padding
 117  * @used_ebs: how many logical eraseblocks in this volume contain data
 118  * @last_eb_bytes: how many bytes are stored in the last logical eraseblock
 119  * @used_bytes: how many bytes of data this volume contains
 120  * @upd_marker: non-zero if the update marker is set for this volume
 121  * @corrupted: non-zero if the volume is corrupted (static volumes only)
 122  * @alignment: volume alignment
 123  * @data_pad: how many bytes are not used at the end of physical eraseblocks to
 124  * satisfy the requested alignment
 125  * @name_len: volume name length
 126  * @name: volume name
 127  *
 128  * @updating: whether the volume is being updated
 129  * @upd_ebs: how many eraseblocks are expected to be updated
 130  * @upd_bytes: how many bytes are expected to be received
 131  * @upd_received: how many update bytes were already received
 132  * @upd_buf: update buffer which is used to collect update data
 133  *
 134  * @eba_tbl: EBA table of this volume (LEB->PEB mapping)
 135  *
 136  * @gluebi_desc: gluebi UBI volume descriptor
 137  * @gluebi_refcount: reference count of the gluebi MTD device
 138  * @gluebi_mtd: MTD device description object of the gluebi MTD device
 139  *
 140  * The @corrupted field indicates that the volume's contents is corrupted.
 141  * Since UBI protects only static volumes, this field is not relevant to
 142  * dynamic volumes - it is user's responsibility to assure their data
 143  * integrity.
 144  *
 145  * The @upd_marker flag indicates that this volume is either being updated at
 146  * the moment or is damaged because of an unclean reboot.
 147  */
 148 struct ubi_volume {
 149         struct device dev;
 150         struct cdev cdev;
 151         struct ubi_device *ubi;
 152         int vol_id;
 153         int readers;
 154         int writers;
 155         int exclusive;
 156         int removed;
 157         int checked;
 158
 159         int reserved_pebs;
 160         int vol_type;
 161         int usable_leb_size;
 162         int used_ebs;
 163         int last_eb_bytes;
 164         long long used_bytes;
 165         int upd_marker;
 166         int corrupted;
 167         int alignment;
 168         int data_pad;
 169         int name_len;
 170         char name[UBI_VOL_NAME_MAX+1];
 171
 172         int updating;
 173         int upd_ebs;
 174         long long upd_bytes;
 175         long long upd_received;
 176         void *upd_buf;
 177
 178         int *eba_tbl;
 179
 180 #ifdef CONFIG_MTD_UBI_GLUEBI
 181         /* Gluebi-related stuff may be compiled out */
 182         struct ubi_volume_desc *gluebi_desc;
 183         int gluebi_refcount;
 184         struct mtd_info gluebi_mtd;
 185 #endif
 186 };
 187
 188 /**
 189  * struct ubi_volume_desc - descriptor of the UBI volume returned when it is
 190  * opened.
 191  * @vol: reference to the corresponding volume description object
 192  * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, or %UBI_EXCLUSIVE)
 193  */
 194 struct ubi_volume_desc {
 195         struct ubi_volume *vol;
 196         int mode;
 197 };
 198
 199 struct ubi_wl_entry;
 200
 201 /**
 202  * struct ubi_device - UBI device description structure
 203  * @dev: class device object to use the the Linux device model
 204  * @cdev: character device object to create character device
 205  * @ubi_num: UBI device number
 206  * @ubi_name: UBI device name
 207  * @major: character device major number
 208  * @vol_count: number of volumes in this UBI device
 209  * @volumes: volumes of this UBI device
 210  * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs,
 211  * @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count, @vol->readers,
 212  * @vol->writers, @vol->exclusive, @vol->removed, @vol->mapping and
 213  * @vol->eba_tbl.
 214  *
 215  * @rsvd_pebs: count of reserved physical eraseblocks
 216  * @avail_pebs: count of available physical eraseblocks
 217  * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB
 218  * handling
 219  * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling
 220  *
 221  * @vtbl_slots: how many slots are available in the volume table
 222  * @vtbl_size: size of the volume table in bytes
 223  * @vtbl: in-RAM volume table copy
 224  *
 225  * @max_ec: current highest erase counter value
 226  * @mean_ec: current mean erase counter value
 227  *
 228  * global_sqnum: global sequence number
 229  * @ltree_lock: protects the lock tree and @global_sqnum
 230  * @ltree: the lock tree
 231  * @vtbl_mutex: protects on-flash volume table
 232  *
 233  * @used: RB-tree of used physical eraseblocks
 234  * @free: RB-tree of free physical eraseblocks
 235  * @scrub: RB-tree of physical eraseblocks which need scrubbing
 236  * @prot: protection trees
 237  * @prot.pnum: protection tree indexed by physical eraseblock numbers
 238  * @prot.aec: protection tree indexed by absolute erase counter value
 239  * @wl_lock: protects the @used, @free, @prot, @lookuptbl, @abs_ec, @move_from,
 240  * @move_to, @move_to_put @erase_pending, @wl_scheduled, and @works
 241  * fields
 242  * @wl_scheduled: non-zero if the wear-leveling was scheduled
 243  * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
 244  * physical eraseblock
 245  * @abs_ec: absolute erase counter
 246  * @move_from: physical eraseblock from where the data is being moved
 247  * @move_to: physical eraseblock where the data is being moved to
 248  * @move_from_put: if the "from" PEB was put
 249  * @move_to_put: if the "to" PEB was put
 250  * @works: list of pending works
 251  * @works_count: count of pending works
 252  * @bgt_thread: background thread description object
 253  * @thread_enabled: if the background thread is enabled
 254  * @bgt_name: background thread name
 255  *
 256  * @flash_size: underlying MTD device size (in bytes)
 257  * @peb_count: count of physical eraseblocks on the MTD device
 258  * @peb_size: physical eraseblock size
 259  * @bad_peb_count: count of bad physical eraseblocks
 260  * @good_peb_count: count of good physical eraseblocks
 261  * @min_io_size: minimal input/output unit size of the underlying MTD device
 262  * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers
 263  * @ro_mode: if the UBI device is in read-only mode
 264  * @leb_size: logical eraseblock size
 265  * @leb_start: starting offset of logical eraseblocks within physical
 266  * eraseblocks
 267  * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size
 268  * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size
 269  * @vid_hdr_offset: starting offset of the volume identifier header (might be
 270  * unaligned)
 271  * @vid_hdr_aloffset: starting offset of the VID header aligned to
 272  * @hdrs_min_io_size
 273  * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset
 274  * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or
 275  * not
 276  * @mtd: MTD device descriptor
 277  */
 278 struct ubi_device {
 279         struct cdev cdev;
 280         struct device dev;
 281         int ubi_num;
 282         char ubi_name[sizeof(UBI_NAME_STR)+5];
 283         int major;
 284         int vol_count;
 285         struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT];
 286         spinlock_t volumes_lock;
 287
 288         int rsvd_pebs;
 289         int avail_pebs;
 290         int beb_rsvd_pebs;
 291         int beb_rsvd_level;
 292
 293         int vtbl_slots;
 294         int vtbl_size;
 295         struct ubi_vtbl_record *vtbl;
 296         struct mutex vtbl_mutex;
 297
 298         int max_ec;
 299         int mean_ec;
 300
 301         /* EBA unit's stuff */
 302         unsigned long long global_sqnum;
 303         spinlock_t ltree_lock;
 304         struct rb_root ltree;
 305
 306         /* Wear-leveling unit's stuff */
 307         struct rb_root used;
 308         struct rb_root free;
 309         struct rb_root scrub;
 310         struct {
 311                 struct rb_root pnum;
 312                 struct rb_root aec;
 313         } prot;
 314         spinlock_t wl_lock;
 315         int wl_scheduled;
 316         struct ubi_wl_entry **lookuptbl;
 317         unsigned long long abs_ec;
 318         struct ubi_wl_entry *move_from;
 319         struct ubi_wl_entry *move_to;
 320         int move_from_put;
 321         int move_to_put;
 322         struct list_head works;
 323         int works_count;
 324         struct task_struct *bgt_thread;
 325         int thread_enabled;
 326         char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2];
 327
 328         /* I/O unit's stuff */
 329         long long flash_size;
 330         int peb_count;
 331         int peb_size;
 332         int bad_peb_count;
 333         int good_peb_count;
 334         int min_io_size;
 335         int hdrs_min_io_size;
 336         int ro_mode;
 337         int leb_size;
 338         int leb_start;
 339         int ec_hdr_alsize;
 340         int vid_hdr_alsize;
 341         int vid_hdr_offset;
 342         int vid_hdr_aloffset;
 343         int vid_hdr_shift;
 344         int bad_allowed;
 345         struct mtd_info *mtd;
 346 };
 347
 348 extern struct file_operations ubi_cdev_operations;
 349 extern struct file_operations ubi_vol_cdev_operations;
 350 extern struct class *ubi_class;
 351
 352 /* vtbl.c */
 353 int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
 354                            struct ubi_vtbl_record *vtbl_rec);
 355 int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_scan_info *si);
 356
 357 /* vmt.c */
 358 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req);
 359 int ubi_remove_volume(struct ubi_volume_desc *desc);
 360 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs);
 361 int ubi_add_volume(struct ubi_device *ubi, int vol_id);
 362 void ubi_free_volume(struct ubi_device *ubi, int vol_id);
 363
 364 /* upd.c */
 365 int ubi_start_update(struct ubi_device *ubi, int vol_id, long long bytes);
 366 int ubi_more_update_data(struct ubi_device *ubi, int vol_id,
 367                          const void __user *buf, int count);
 368
 369 /* misc.c */
 370 int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf, int length);
 371 int ubi_check_volume(struct ubi_device *ubi, int vol_id);
 372 void ubi_calculate_reserved(struct ubi_device *ubi);
 373
 374 /* gluebi.c */
 375 #ifdef CONFIG_MTD_UBI_GLUEBI
 376 int ubi_create_gluebi(struct ubi_device *ubi, struct ubi_volume *vol);
 377 int ubi_destroy_gluebi(struct ubi_volume *vol);
 378 void ubi_gluebi_updated(struct ubi_volume *vol);
 379 #else
 380 #define ubi_create_gluebi(ubi, vol) 0
 381 #define ubi_destroy_gluebi(vol) 0
 382 #define ubi_gluebi_updated(vol)
 383 #endif
 384
 385 /* eba.c */
 386 int ubi_eba_unmap_leb(struct ubi_device *ubi, int vol_id, int lnum);
 387 int ubi_eba_read_leb(struct ubi_device *ubi, int vol_id, int lnum, void *buf,
 388                      int offset, int len, int check);
 389 int ubi_eba_write_leb(struct ubi_device *ubi, int vol_id, int lnum,
 390                       const void *buf, int offset, int len, int dtype);
 391 int ubi_eba_write_leb_st(struct ubi_device *ubi, int vol_id, int lnum,
 392                          const void *buf, int len, int dtype,
 393                          int used_ebs);
 394 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, int vol_id, int lnum,
 395                               const void *buf, int len, int dtype);
 396 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
 397                      struct ubi_vid_hdr *vid_hdr);
 398 int ubi_eba_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si);
 399 void ubi_eba_close(const struct ubi_device *ubi);
 400
 401 /* wl.c */
 402 int ubi_wl_get_peb(struct ubi_device *ubi, int dtype);
 403 int ubi_wl_put_peb(struct ubi_device *ubi, int pnum, int torture);
 404 int ubi_wl_flush(struct ubi_device *ubi);
 405 int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum);
 406 int ubi_wl_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si);
 407 void ubi_wl_close(struct ubi_device *ubi);
 408
 409 /* io.c */
 410 int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
 411                 int len);
 412 int ubi_io_write(const struct ubi_device *ubi, const void *buf, int pnum,
 413                  int offset, int len);
 414 int ubi_io_sync_erase(const struct ubi_device *ubi, int pnum, int torture);
 415 int ubi_io_is_bad(const struct ubi_device *ubi, int pnum);
 416 int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum);
 417 int ubi_io_read_ec_hdr(const struct ubi_device *ubi, int pnum,
 418                        struct ubi_ec_hdr *ec_hdr, int verbose);
 419 int ubi_io_write_ec_hdr(const struct ubi_device *ubi, int pnum,
 420                         struct ubi_ec_hdr *ec_hdr);
 421 int ubi_io_read_vid_hdr(const struct ubi_device *ubi, int pnum,
 422                         struct ubi_vid_hdr *vid_hdr, int verbose);
 423 int ubi_io_write_vid_hdr(const struct ubi_device *ubi, int pnum,
 424                          struct ubi_vid_hdr *vid_hdr);
 425
 426 /*
 427  * ubi_rb_for_each_entry - walk an RB-tree.
 428  * @rb: a pointer to type 'struct rb_node' to to use as a loop counter
 429  * @pos: a pointer to RB-tree entry type to use as a loop counter
 430  * @root: RB-tree's root
 431  * @member: the name of the 'struct rb_node' within the RB-tree entry
 432  */
 433 #define ubi_rb_for_each_entry(rb, pos, root, member)                         \
 434         for (rb = rb_first(root),                                            \
 435              pos = (rb ? container_of(rb, typeof(*pos), member) : NULL);     \
 436              rb;                                                             \
 437              rb = rb_next(rb), pos = container_of(rb, typeof(*pos), member))
 438
 439 /**
 440  * ubi_zalloc_vid_hdr - allocate a volume identifier header object.
 441  * @ubi: UBI device description object
 442  *
 443  * This function returns a pointer to the newly allocated and zero-filled
 444  * volume identifier header object in case of success and %NULL in case of
 445  * failure.
 446  */
 447 static inline struct ubi_vid_hdr *ubi_zalloc_vid_hdr(const struct ubi_device *ubi)
 448 {
 449         void *vid_hdr;
 450
 451         vid_hdr = kzalloc(ubi->vid_hdr_alsize, GFP_KERNEL);
 452         if (!vid_hdr)
 453                 return NULL;
 454
 455         /*
 456          * VID headers may be stored at un-aligned flash offsets, so we shift
 457          * the pointer.
 458          */
 459         return vid_hdr + ubi->vid_hdr_shift;
 460 }
 461
 462 /**
 463  * ubi_free_vid_hdr - free a volume identifier header object.
 464  * @ubi: UBI device description object
 465  * @vid_hdr: the object to free
 466  */
 467 static inline void ubi_free_vid_hdr(const struct ubi_device *ubi,
 468                                     struct ubi_vid_hdr *vid_hdr)
 469 {
 470         void *p = vid_hdr;
 471
 472         if (!p)
 473                 return;
 474
 475         kfree(p - ubi->vid_hdr_shift);
 476 }
 477
 478 /*
 479  * This function is equivalent to 'ubi_io_read()', but @offset is relative to
 480  * the beginning of the logical eraseblock, not to the beginning of the
 481  * physical eraseblock.
 482  */
 483 static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf,
 484                                    int pnum, int offset, int len)
 485 {
 486         ubi_assert(offset >= 0);
 487         return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len);
 488 }
 489
 490 /*
 491  * This function is equivalent to 'ubi_io_write()', but @offset is relative to
 492  * the beginning of the logical eraseblock, not to the beginning of the
 493  * physical eraseblock.
 494  */
 495 static inline int ubi_io_write_data(const struct ubi_device *ubi, const void *buf,
 496                                     int pnum, int offset, int len)
 497 {
 498         ubi_assert(offset >= 0);
 499         return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len);
 500 }
 501
 502 /**
 503  * ubi_ro_mode - switch to read-only mode.
 504  * @ubi: UBI device description object
 505  */
 506 static inline void ubi_ro_mode(struct ubi_device *ubi)
 507 {
 508         ubi->ro_mode = 1;
 509         ubi_warn("switch to read-only mode");
 510 }
 511
 512 /**
 513  * vol_id2idx - get table index by volume ID.
 514  * @ubi: UBI device description object
 515  * @vol_id: volume ID
 516  */
 517 static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id)
 518 {
 519         if (vol_id >= UBI_INTERNAL_VOL_START)
 520                 return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots;
 521         else
 522                 return vol_id;
 523 }
 524
 525 /**
 526  * idx2vol_id - get volume ID by table index.
 527  * @ubi: UBI device description object
 528  * @idx: table index
 529  */
 530 static inline int idx2vol_id(const struct ubi_device *ubi, int idx)
 531 {
 532         if (idx >= ubi->vtbl_slots)
 533                 return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START;
 534         else
 535                 return idx;
 536 }
 537
 538 #endif /* !__UBI_UBI_H__ */