1/* SPDX-License-Identifier: GPL-2.0+ */ 2/* 3 * Copyright (c) International Business Machines Corp., 2006 4 * Copyright (c) Nokia Corporation, 2006, 2007 5 * 6 * Author: Artem Bityutskiy (Битюцкий Артём) 7 */ 8 9#ifndef __UBI_UBI_H__ 10#define __UBI_UBI_H__ 11 12#ifndef __UBOOT__ 13#include <linux/types.h> 14#include <linux/list.h> 15#include <linux/rbtree.h> 16#include <linux/sched.h> 17#include <linux/wait.h> 18#include <linux/mutex.h> 19#include <linux/rwsem.h> 20#include <linux/spinlock.h> 21#include <linux/fs.h> 22#include <linux/cdev.h> 23#include <linux/device.h> 24#include <linux/slab.h> 25#include <linux/string.h> 26#include <linux/vmalloc.h> 27#include <linux/notifier.h> 28#include <asm/pgtable.h> 29#else 30#include <ubi_uboot.h> 31#endif 32#include <linux/mtd/mtd.h> 33#include <linux/mtd/ubi.h> 34#include "ubi-media.h" 35#include <mtd/ubi-user.h> 36 37/* Maximum number of supported UBI devices */ 38#define UBI_MAX_DEVICES 32 39 40/* UBI name used for character devices, sysfs, etc */ 41#define UBI_NAME_STR "ubi" 42 43/* Normal UBI messages */ 44#ifdef CONFIG_UBI_SILENCE_MSG 45#define ubi_msg(ubi, fmt, ...) 46#else 47#define ubi_msg(ubi, fmt, ...) printk(UBI_NAME_STR "%d: " fmt "\n", \ 48 ubi->ubi_num, ##__VA_ARGS__) 49#endif 50 51/* UBI warning messages */ 52#define ubi_warn(ubi, fmt, ...) pr_warn(UBI_NAME_STR "%d warning: %s: " fmt "\n", \ 53 ubi->ubi_num, __func__, ##__VA_ARGS__) 54/* UBI error messages */ 55#define ubi_err(ubi, fmt, ...) pr_err(UBI_NAME_STR "%d error: %s: " fmt "\n", \ 56 ubi->ubi_num, __func__, ##__VA_ARGS__) 57 58/* Background thread name pattern */ 59#define UBI_BGT_NAME_PATTERN "ubi_bgt%dd" 60 61/* 62 * This marker in the EBA table means that the LEB is um-mapped. 63 * NOTE! It has to have the same value as %UBI_ALL. 64 */ 65#define UBI_LEB_UNMAPPED -1 66 67/* 68 * In case of errors, UBI tries to repeat the operation several times before 69 * returning error. The below constant defines how many times UBI re-tries. 70 */ 71#define UBI_IO_RETRIES 3 72 73/* 74 * Length of the protection queue. The length is effectively equivalent to the 75 * number of (global) erase cycles PEBs are protected from the wear-leveling 76 * worker. 77 */ 78#define UBI_PROT_QUEUE_LEN 10 79 80/* The volume ID/LEB number/erase counter is unknown */ 81#define UBI_UNKNOWN -1 82 83/* 84 * The UBI debugfs directory name pattern and maximum name length (3 for "ubi" 85 * + 2 for the number plus 1 for the trailing zero byte. 86 */ 87#define UBI_DFS_DIR_NAME "ubi%d" 88#define UBI_DFS_DIR_LEN (3 + 2 + 1) 89 90/* 91 * Error codes returned by the I/O sub-system. 92 * 93 * UBI_IO_FF: the read region of flash contains only 0xFFs 94 * UBI_IO_FF_BITFLIPS: the same as %UBI_IO_FF, but also also there was a data 95 * integrity error reported by the MTD driver 96 * (uncorrectable ECC error in case of NAND) 97 * UBI_IO_BAD_HDR: the EC or VID header is corrupted (bad magic or CRC) 98 * UBI_IO_BAD_HDR_EBADMSG: the same as %UBI_IO_BAD_HDR, but also there was a 99 * data integrity error reported by the MTD driver 100 * (uncorrectable ECC error in case of NAND) 101 * UBI_IO_BITFLIPS: bit-flips were detected and corrected 102 * 103 * Note, it is probably better to have bit-flip and ebadmsg as flags which can 104 * be or'ed with other error code. But this is a big change because there are 105 * may callers, so it does not worth the risk of introducing a bug 106 */ 107enum { 108 UBI_IO_FF = 1, 109 UBI_IO_FF_BITFLIPS, 110 UBI_IO_BAD_HDR, 111 UBI_IO_BAD_HDR_EBADMSG, 112 UBI_IO_BITFLIPS, 113}; 114 115/* 116 * Return codes of the 'ubi_eba_copy_leb()' function. 117 * 118 * MOVE_CANCEL_RACE: canceled because the volume is being deleted, the source 119 * PEB was put meanwhile, or there is I/O on the source PEB 120 * MOVE_SOURCE_RD_ERR: canceled because there was a read error from the source 121 * PEB 122 * MOVE_TARGET_RD_ERR: canceled because there was a read error from the target 123 * PEB 124 * MOVE_TARGET_WR_ERR: canceled because there was a write error to the target 125 * PEB 126 * MOVE_TARGET_BITFLIPS: canceled because a bit-flip was detected in the 127 * target PEB 128 * MOVE_RETRY: retry scrubbing the PEB 129 */ 130enum { 131 MOVE_CANCEL_RACE = 1, 132 MOVE_SOURCE_RD_ERR, 133 MOVE_TARGET_RD_ERR, 134 MOVE_TARGET_WR_ERR, 135 MOVE_TARGET_BITFLIPS, 136 MOVE_RETRY, 137}; 138 139/* 140 * Return codes of the fastmap sub-system 141 * 142 * UBI_NO_FASTMAP: No fastmap super block was found 143 * UBI_BAD_FASTMAP: A fastmap was found but it's unusable 144 */ 145enum { 146 UBI_NO_FASTMAP = 1, 147 UBI_BAD_FASTMAP, 148}; 149 150/* 151 * Flags for emulate_power_cut in ubi_debug_info 152 * 153 * POWER_CUT_EC_WRITE: Emulate a power cut when writing an EC header 154 * POWER_CUT_VID_WRITE: Emulate a power cut when writing a VID header 155 */ 156enum { 157 POWER_CUT_EC_WRITE = 0x01, 158 POWER_CUT_VID_WRITE = 0x02, 159}; 160 161/** 162 * struct ubi_wl_entry - wear-leveling entry. 163 * @u.rb: link in the corresponding (free/used) RB-tree 164 * @u.list: link in the protection queue 165 * @ec: erase counter 166 * @pnum: physical eraseblock number 167 * 168 * This data structure is used in the WL sub-system. Each physical eraseblock 169 * has a corresponding &struct wl_entry object which may be kept in different 170 * RB-trees. See WL sub-system for details. 171 */ 172struct ubi_wl_entry { 173 union { 174 struct rb_node rb; 175 struct list_head list; 176 } u; 177 int ec; 178 int pnum; 179}; 180 181/** 182 * struct ubi_ltree_entry - an entry in the lock tree. 183 * @rb: links RB-tree nodes 184 * @vol_id: volume ID of the locked logical eraseblock 185 * @lnum: locked logical eraseblock number 186 * @users: how many tasks are using this logical eraseblock or wait for it 187 * @mutex: read/write mutex to implement read/write access serialization to 188 * the (@vol_id, @lnum) logical eraseblock 189 * 190 * This data structure is used in the EBA sub-system to implement per-LEB 191 * locking. When a logical eraseblock is being locked - corresponding 192 * &struct ubi_ltree_entry object is inserted to the lock tree (@ubi->ltree). 193 * See EBA sub-system for details. 194 */ 195struct ubi_ltree_entry { 196 struct rb_node rb; 197 int vol_id; 198 int lnum; 199 int users; 200 struct rw_semaphore mutex; 201}; 202 203/** 204 * struct ubi_rename_entry - volume re-name description data structure. 205 * @new_name_len: new volume name length 206 * @new_name: new volume name 207 * @remove: if not zero, this volume should be removed, not re-named 208 * @desc: descriptor of the volume 209 * @list: links re-name entries into a list 210 * 211 * This data structure is utilized in the multiple volume re-name code. Namely, 212 * UBI first creates a list of &struct ubi_rename_entry objects from the 213 * &struct ubi_rnvol_req request object, and then utilizes this list to do all 214 * the job. 215 */ 216struct ubi_rename_entry { 217 int new_name_len; 218 char new_name[UBI_VOL_NAME_MAX + 1]; 219 int remove; 220 struct ubi_volume_desc *desc; 221 struct list_head list; 222}; 223 224struct ubi_volume_desc; 225 226/** 227 * struct ubi_fastmap_layout - in-memory fastmap data structure. 228 * @e: PEBs used by the current fastmap 229 * @to_be_tortured: if non-zero tortured this PEB 230 * @used_blocks: number of used PEBs 231 * @max_pool_size: maximal size of the user pool 232 * @max_wl_pool_size: maximal size of the pool used by the WL sub-system 233 */ 234struct ubi_fastmap_layout { 235 struct ubi_wl_entry *e[UBI_FM_MAX_BLOCKS]; 236 int to_be_tortured[UBI_FM_MAX_BLOCKS]; 237 int used_blocks; 238 int max_pool_size; 239 int max_wl_pool_size; 240}; 241 242/** 243 * struct ubi_fm_pool - in-memory fastmap pool 244 * @pebs: PEBs in this pool 245 * @used: number of used PEBs 246 * @size: total number of PEBs in this pool 247 * @max_size: maximal size of the pool 248 * 249 * A pool gets filled with up to max_size. 250 * If all PEBs within the pool are used a new fastmap will be written 251 * to the flash and the pool gets refilled with empty PEBs. 252 * 253 */ 254struct ubi_fm_pool { 255 int pebs[UBI_FM_MAX_POOL_SIZE]; 256 int used; 257 int size; 258 int max_size; 259}; 260 261/** 262 * struct ubi_volume - UBI volume description data structure. 263 * @dev: device object to make use of the the Linux device model 264 * @cdev: character device object to create character device 265 * @ubi: reference to the UBI device description object 266 * @vol_id: volume ID 267 * @ref_count: volume reference count 268 * @readers: number of users holding this volume in read-only mode 269 * @writers: number of users holding this volume in read-write mode 270 * @exclusive: whether somebody holds this volume in exclusive mode 271 * @metaonly: whether somebody is altering only meta data of this volume 272 * 273 * @reserved_pebs: how many physical eraseblocks are reserved for this volume 274 * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME) 275 * @usable_leb_size: logical eraseblock size without padding 276 * @used_ebs: how many logical eraseblocks in this volume contain data 277 * @last_eb_bytes: how many bytes are stored in the last logical eraseblock 278 * @used_bytes: how many bytes of data this volume contains 279 * @alignment: volume alignment 280 * @data_pad: how many bytes are not used at the end of physical eraseblocks to 281 * satisfy the requested alignment 282 * @name_len: volume name length 283 * @name: volume name 284 * 285 * @upd_ebs: how many eraseblocks are expected to be updated 286 * @ch_lnum: LEB number which is being changing by the atomic LEB change 287 * operation 288 * @upd_bytes: how many bytes are expected to be received for volume update or 289 * atomic LEB change 290 * @upd_received: how many bytes were already received for volume update or 291 * atomic LEB change 292 * @upd_buf: update buffer which is used to collect update data or data for 293 * atomic LEB change 294 * 295 * @eba_tbl: EBA table of this volume (LEB->PEB mapping) 296 * @skip_check: %1 if CRC check of this static volume should be skipped. 297 * Directly reflects the presence of the 298 * %UBI_VTBL_SKIP_CRC_CHECK_FLG flag in the vtbl entry 299 * @checked: %1 if this static volume was checked 300 * @corrupted: %1 if the volume is corrupted (static volumes only) 301 * @upd_marker: %1 if the update marker is set for this volume 302 * @updating: %1 if the volume is being updated 303 * @changing_leb: %1 if the atomic LEB change ioctl command is in progress 304 * @direct_writes: %1 if direct writes are enabled for this volume 305 * 306 * The @corrupted field indicates that the volume's contents is corrupted. 307 * Since UBI protects only static volumes, this field is not relevant to 308 * dynamic volumes - it is user's responsibility to assure their data 309 * integrity. 310 * 311 * The @upd_marker flag indicates that this volume is either being updated at 312 * the moment or is damaged because of an unclean reboot. 313 */ 314struct ubi_volume { 315 struct device dev; 316 struct cdev cdev; 317 struct ubi_device *ubi; 318 int vol_id; 319 int ref_count; 320 int readers; 321 int writers; 322 int exclusive; 323 int metaonly; 324 325 int reserved_pebs; 326 int vol_type; 327 int usable_leb_size; 328 int used_ebs; 329#ifndef __UBOOT__ 330 int last_eb_bytes; 331#else 332 u32 last_eb_bytes; 333#endif 334 long long used_bytes; 335 int alignment; 336 int data_pad; 337 int name_len; 338 char name[UBI_VOL_NAME_MAX + 1]; 339 340 int upd_ebs; 341 int ch_lnum; 342 long long upd_bytes; 343 long long upd_received; 344 void *upd_buf; 345 346 int *eba_tbl; 347 unsigned int skip_check:1; 348 unsigned int checked:1; 349 unsigned int corrupted:1; 350 unsigned int upd_marker:1; 351 unsigned int updating:1; 352 unsigned int changing_leb:1; 353 unsigned int direct_writes:1; 354}; 355 356/** 357 * struct ubi_volume_desc - UBI volume descriptor returned when it is opened. 358 * @vol: reference to the corresponding volume description object 359 * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, %UBI_EXCLUSIVE 360 * or %UBI_METAONLY) 361 */ 362struct ubi_volume_desc { 363 struct ubi_volume *vol; 364 int mode; 365}; 366 367struct ubi_wl_entry; 368 369/** 370 * struct ubi_debug_info - debugging information for an UBI device. 371 * 372 * @chk_gen: if UBI general extra checks are enabled 373 * @chk_io: if UBI I/O extra checks are enabled 374 * @chk_fastmap: if UBI fastmap extra checks are enabled 375 * @disable_bgt: disable the background task for testing purposes 376 * @emulate_bitflips: emulate bit-flips for testing purposes 377 * @emulate_io_failures: emulate write/erase failures for testing purposes 378 * @emulate_power_cut: emulate power cut for testing purposes 379 * @power_cut_counter: count down for writes left until emulated power cut 380 * @power_cut_min: minimum number of writes before emulating a power cut 381 * @power_cut_max: maximum number of writes until emulating a power cut 382 * @dfs_dir_name: name of debugfs directory containing files of this UBI device 383 * @dfs_dir: direntry object of the UBI device debugfs directory 384 * @dfs_chk_gen: debugfs knob to enable UBI general extra checks 385 * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks 386 * @dfs_chk_fastmap: debugfs knob to enable UBI fastmap extra checks 387 * @dfs_disable_bgt: debugfs knob to disable the background task 388 * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips 389 * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures 390 * @dfs_emulate_power_cut: debugfs knob to emulate power cuts 391 * @dfs_power_cut_min: debugfs knob for minimum writes before power cut 392 * @dfs_power_cut_max: debugfs knob for maximum writes until power cut 393 */ 394struct ubi_debug_info { 395 unsigned int chk_gen:1; 396 unsigned int chk_io:1; 397 unsigned int chk_fastmap:1; 398 unsigned int disable_bgt:1; 399 unsigned int emulate_bitflips:1; 400 unsigned int emulate_io_failures:1; 401 unsigned int emulate_power_cut:2; 402 unsigned int power_cut_counter; 403 unsigned int power_cut_min; 404 unsigned int power_cut_max; 405 char dfs_dir_name[UBI_DFS_DIR_LEN + 1]; 406 struct dentry *dfs_dir; 407 struct dentry *dfs_chk_gen; 408 struct dentry *dfs_chk_io; 409 struct dentry *dfs_chk_fastmap; 410 struct dentry *dfs_disable_bgt; 411 struct dentry *dfs_emulate_bitflips; 412 struct dentry *dfs_emulate_io_failures; 413 struct dentry *dfs_emulate_power_cut; 414 struct dentry *dfs_power_cut_min; 415 struct dentry *dfs_power_cut_max; 416}; 417 418/** 419 * struct ubi_device - UBI device description structure 420 * @dev: UBI device object to use the the Linux device model 421 * @cdev: character device object to create character device 422 * @ubi_num: UBI device number 423 * @ubi_name: UBI device name 424 * @vol_count: number of volumes in this UBI device 425 * @volumes: volumes of this UBI device 426 * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs, 427 * @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count, 428 * @vol->readers, @vol->writers, @vol->exclusive, 429 * @vol->metaonly, @vol->ref_count, @vol->mapping and 430 * @vol->eba_tbl. 431 * @ref_count: count of references on the UBI device 432 * @image_seq: image sequence number recorded on EC headers 433 * 434 * @rsvd_pebs: count of reserved physical eraseblocks 435 * @avail_pebs: count of available physical eraseblocks 436 * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB 437 * handling 438 * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling 439 * 440 * @autoresize_vol_id: ID of the volume which has to be auto-resized at the end 441 * of UBI initialization 442 * @vtbl_slots: how many slots are available in the volume table 443 * @vtbl_size: size of the volume table in bytes 444 * @vtbl: in-RAM volume table copy 445 * @device_mutex: protects on-flash volume table and serializes volume 446 * creation, deletion, update, re-size, re-name and set 447 * property 448 * 449 * @max_ec: current highest erase counter value 450 * @mean_ec: current mean erase counter value 451 * 452 * @global_sqnum: global sequence number 453 * @ltree_lock: protects the lock tree and @global_sqnum 454 * @ltree: the lock tree 455 * @alc_mutex: serializes "atomic LEB change" operations 456 * 457 * @fm_disabled: non-zero if fastmap is disabled (default) 458 * @fm: in-memory data structure of the currently used fastmap 459 * @fm_pool: in-memory data structure of the fastmap pool 460 * @fm_wl_pool: in-memory data structure of the fastmap pool used by the WL 461 * sub-system 462 * @fm_protect: serializes ubi_update_fastmap(), protects @fm_buf and makes sure 463 * that critical sections cannot be interrupted by ubi_update_fastmap() 464 * @fm_buf: vmalloc()'d buffer which holds the raw fastmap 465 * @fm_size: fastmap size in bytes 466 * @fm_eba_sem: allows ubi_update_fastmap() to block EBA table changes 467 * @fm_work: fastmap work queue 468 * @fm_work_scheduled: non-zero if fastmap work was scheduled 469 * 470 * @used: RB-tree of used physical eraseblocks 471 * @erroneous: RB-tree of erroneous used physical eraseblocks 472 * @free: RB-tree of free physical eraseblocks 473 * @free_count: Contains the number of elements in @free 474 * @scrub: RB-tree of physical eraseblocks which need scrubbing 475 * @pq: protection queue (contain physical eraseblocks which are temporarily 476 * protected from the wear-leveling worker) 477 * @pq_head: protection queue head 478 * @wl_lock: protects the @used, @free, @pq, @pq_head, @lookuptbl, @move_from, 479 * @move_to, @move_to_put @erase_pending, @wl_scheduled, @works, 480 * @erroneous, @erroneous_peb_count, @fm_work_scheduled, @fm_pool, 481 * and @fm_wl_pool fields 482 * @move_mutex: serializes eraseblock moves 483 * @work_sem: used to wait for all the scheduled works to finish and prevent 484 * new works from being submitted 485 * @wl_scheduled: non-zero if the wear-leveling was scheduled 486 * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any 487 * physical eraseblock 488 * @move_from: physical eraseblock from where the data is being moved 489 * @move_to: physical eraseblock where the data is being moved to 490 * @move_to_put: if the "to" PEB was put 491 * @works: list of pending works 492 * @works_count: count of pending works 493 * @bgt_thread: background thread description object 494 * @thread_enabled: if the background thread is enabled 495 * @bgt_name: background thread name 496 * 497 * @flash_size: underlying MTD device size (in bytes) 498 * @peb_count: count of physical eraseblocks on the MTD device 499 * @peb_size: physical eraseblock size 500 * @bad_peb_limit: top limit of expected bad physical eraseblocks 501 * @bad_peb_count: count of bad physical eraseblocks 502 * @good_peb_count: count of good physical eraseblocks 503 * @corr_peb_count: count of corrupted physical eraseblocks (preserved and not 504 * used by UBI) 505 * @erroneous_peb_count: count of erroneous physical eraseblocks in @erroneous 506 * @max_erroneous: maximum allowed amount of erroneous physical eraseblocks 507 * @min_io_size: minimal input/output unit size of the underlying MTD device 508 * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers 509 * @ro_mode: if the UBI device is in read-only mode 510 * @leb_size: logical eraseblock size 511 * @leb_start: starting offset of logical eraseblocks within physical 512 * eraseblocks 513 * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size 514 * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size 515 * @vid_hdr_offset: starting offset of the volume identifier header (might be 516 * unaligned) 517 * @vid_hdr_aloffset: starting offset of the VID header aligned to 518 * @hdrs_min_io_size 519 * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset 520 * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or 521 * not 522 * @nor_flash: non-zero if working on top of NOR flash 523 * @max_write_size: maximum amount of bytes the underlying flash can write at a 524 * time (MTD write buffer size) 525 * @mtd: MTD device descriptor 526 * 527 * @peb_buf: a buffer of PEB size used for different purposes 528 * @buf_mutex: protects @peb_buf 529 * @ckvol_mutex: serializes static volume checking when opening 530 * 531 * @dbg: debugging information for this UBI device 532 */ 533struct ubi_device { 534 struct cdev cdev; 535 struct device dev; 536 int ubi_num; 537 char ubi_name[sizeof(UBI_NAME_STR)+5]; 538 int vol_count; 539 struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT]; 540 spinlock_t volumes_lock; 541 int ref_count; 542 int image_seq; 543 544 int rsvd_pebs; 545 int avail_pebs; 546 int beb_rsvd_pebs; 547 int beb_rsvd_level; 548 int bad_peb_limit; 549 550 int autoresize_vol_id; 551 int vtbl_slots; 552 int vtbl_size; 553 struct ubi_vtbl_record *vtbl; 554 struct mutex device_mutex; 555 556 int max_ec; 557 /* Note, mean_ec is not updated run-time - should be fixed */ 558 int mean_ec; 559 560 /* EBA sub-system's stuff */ 561 unsigned long long global_sqnum; 562 spinlock_t ltree_lock; 563 struct rb_root ltree; 564 struct mutex alc_mutex; 565 566 /* Fastmap stuff */ 567 int fm_disabled; 568 struct ubi_fastmap_layout *fm; 569 struct ubi_fm_pool fm_pool; 570 struct ubi_fm_pool fm_wl_pool; 571 struct rw_semaphore fm_eba_sem; 572 struct rw_semaphore fm_protect; 573 void *fm_buf; 574 size_t fm_size; 575#ifndef __UBOOT__ 576 struct work_struct fm_work; 577#endif 578 int fm_work_scheduled; 579 580 /* Wear-leveling sub-system's stuff */ 581 struct rb_root used; 582 struct rb_root erroneous; 583 struct rb_root free; 584 int free_count; 585 struct rb_root scrub; 586 struct list_head pq[UBI_PROT_QUEUE_LEN]; 587 int pq_head; 588 spinlock_t wl_lock; 589 struct mutex move_mutex; 590 struct rw_semaphore work_sem; 591 int wl_scheduled; 592 struct ubi_wl_entry **lookuptbl; 593 struct ubi_wl_entry *move_from; 594 struct ubi_wl_entry *move_to; 595 int move_to_put; 596 struct list_head works; 597 int works_count; 598 struct task_struct *bgt_thread; 599 int thread_enabled; 600 char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2]; 601 602 /* I/O sub-system's stuff */ 603 long long flash_size; 604 int peb_count; 605 int peb_size; 606 int bad_peb_count; 607 int good_peb_count; 608 int corr_peb_count; 609 int erroneous_peb_count; 610 int max_erroneous; 611 int min_io_size; 612 int hdrs_min_io_size; 613 int ro_mode; 614 int leb_size; 615 int leb_start; 616 int ec_hdr_alsize; 617 int vid_hdr_alsize; 618 int vid_hdr_offset; 619 int vid_hdr_aloffset; 620 int vid_hdr_shift; 621 unsigned int bad_allowed:1; 622 unsigned int nor_flash:1; 623 int max_write_size; 624 struct mtd_info *mtd; 625 626 void *peb_buf; 627 struct mutex buf_mutex; 628 struct mutex ckvol_mutex; 629 630 struct ubi_debug_info dbg; 631}; 632 633/** 634 * struct ubi_ainf_peb - attach information about a physical eraseblock. 635 * @ec: erase counter (%UBI_UNKNOWN if it is unknown) 636 * @pnum: physical eraseblock number 637 * @vol_id: ID of the volume this LEB belongs to 638 * @lnum: logical eraseblock number 639 * @scrub: if this physical eraseblock needs scrubbing 640 * @copy_flag: this LEB is a copy (@copy_flag is set in VID header of this LEB) 641 * @sqnum: sequence number 642 * @u: unions RB-tree or @list links 643 * @u.rb: link in the per-volume RB-tree of &struct ubi_ainf_peb objects 644 * @u.list: link in one of the eraseblock lists 645 * 646 * One object of this type is allocated for each physical eraseblock when 647 * attaching an MTD device. Note, if this PEB does not belong to any LEB / 648 * volume, the @vol_id and @lnum fields are initialized to %UBI_UNKNOWN. 649 */ 650struct ubi_ainf_peb { 651 int ec; 652 int pnum; 653 int vol_id; 654 int lnum; 655 unsigned int scrub:1; 656 unsigned int copy_flag:1; 657 unsigned long long sqnum; 658 union { 659 struct rb_node rb; 660 struct list_head list; 661 } u; 662}; 663 664/** 665 * struct ubi_ainf_volume - attaching information about a volume. 666 * @vol_id: volume ID 667 * @highest_lnum: highest logical eraseblock number in this volume 668 * @leb_count: number of logical eraseblocks in this volume 669 * @vol_type: volume type 670 * @used_ebs: number of used logical eraseblocks in this volume (only for 671 * static volumes) 672 * @last_data_size: amount of data in the last logical eraseblock of this 673 * volume (always equivalent to the usable logical eraseblock 674 * size in case of dynamic volumes) 675 * @data_pad: how many bytes at the end of logical eraseblocks of this volume 676 * are not used (due to volume alignment) 677 * @compat: compatibility flags of this volume 678 * @rb: link in the volume RB-tree 679 * @root: root of the RB-tree containing all the eraseblock belonging to this 680 * volume (&struct ubi_ainf_peb objects) 681 * 682 * One object of this type is allocated for each volume when attaching an MTD 683 * device. 684 */ 685struct ubi_ainf_volume { 686 int vol_id; 687 int highest_lnum; 688 int leb_count; 689 int vol_type; 690 int used_ebs; 691 int last_data_size; 692 int data_pad; 693 int compat; 694 struct rb_node rb; 695 struct rb_root root; 696}; 697 698/** 699 * struct ubi_attach_info - MTD device attaching information. 700 * @volumes: root of the volume RB-tree 701 * @corr: list of corrupted physical eraseblocks 702 * @free: list of free physical eraseblocks 703 * @erase: list of physical eraseblocks which have to be erased 704 * @alien: list of physical eraseblocks which should not be used by UBI (e.g., 705 * those belonging to "preserve"-compatible internal volumes) 706 * @corr_peb_count: count of PEBs in the @corr list 707 * @empty_peb_count: count of PEBs which are presumably empty (contain only 708 * 0xFF bytes) 709 * @alien_peb_count: count of PEBs in the @alien list 710 * @bad_peb_count: count of bad physical eraseblocks 711 * @maybe_bad_peb_count: count of bad physical eraseblocks which are not marked 712 * as bad yet, but which look like bad 713 * @vols_found: number of volumes found 714 * @highest_vol_id: highest volume ID 715 * @is_empty: flag indicating whether the MTD device is empty or not 716 * @min_ec: lowest erase counter value 717 * @max_ec: highest erase counter value 718 * @max_sqnum: highest sequence number value 719 * @mean_ec: mean erase counter value 720 * @ec_sum: a temporary variable used when calculating @mean_ec 721 * @ec_count: a temporary variable used when calculating @mean_ec 722 * @aeb_slab_cache: slab cache for &struct ubi_ainf_peb objects 723 * 724 * This data structure contains the result of attaching an MTD device and may 725 * be used by other UBI sub-systems to build final UBI data structures, further 726 * error-recovery and so on. 727 */ 728struct ubi_attach_info { 729 struct rb_root volumes; 730 struct list_head corr; 731 struct list_head free; 732 struct list_head erase; 733 struct list_head alien; 734 int corr_peb_count; 735 int empty_peb_count; 736 int alien_peb_count; 737 int bad_peb_count; 738 int maybe_bad_peb_count; 739 int vols_found; 740 int highest_vol_id; 741 int is_empty; 742 int min_ec; 743 int max_ec; 744 unsigned long long max_sqnum; 745 int mean_ec; 746 uint64_t ec_sum; 747 int ec_count; 748 struct kmem_cache *aeb_slab_cache; 749}; 750 751/** 752 * struct ubi_work - UBI work description data structure. 753 * @list: a link in the list of pending works 754 * @func: worker function 755 * @e: physical eraseblock to erase 756 * @vol_id: the volume ID on which this erasure is being performed 757 * @lnum: the logical eraseblock number 758 * @torture: if the physical eraseblock has to be tortured 759 * @anchor: produce a anchor PEB to by used by fastmap 760 * 761 * The @func pointer points to the worker function. If the @shutdown argument is 762 * not zero, the worker has to free the resources and exit immediately as the 763 * WL sub-system is shutting down. 764 * The worker has to return zero in case of success and a negative error code in 765 * case of failure. 766 */ 767struct ubi_work { 768 struct list_head list; 769 int (*func)(struct ubi_device *ubi, struct ubi_work *wrk, int shutdown); 770 /* The below fields are only relevant to erasure works */ 771 struct ubi_wl_entry *e; 772 int vol_id; 773 int lnum; 774 int torture; 775 int anchor; 776}; 777 778#include "debug.h" 779 780extern struct kmem_cache *ubi_wl_entry_slab; 781extern const struct file_operations ubi_ctrl_cdev_operations; 782extern const struct file_operations ubi_cdev_operations; 783extern const struct file_operations ubi_vol_cdev_operations; 784extern struct class ubi_class; 785extern struct mutex ubi_devices_mutex; 786extern struct blocking_notifier_head ubi_notifiers; 787 788/* attach.c */ 789int ubi_add_to_av(struct ubi_device *ubi, struct ubi_attach_info *ai, int pnum, 790 int ec, const struct ubi_vid_hdr *vid_hdr, int bitflips); 791struct ubi_ainf_volume *ubi_find_av(const struct ubi_attach_info *ai, 792 int vol_id); 793void ubi_remove_av(struct ubi_attach_info *ai, struct ubi_ainf_volume *av); 794struct ubi_ainf_peb *ubi_early_get_peb(struct ubi_device *ubi, 795 struct ubi_attach_info *ai); 796int ubi_attach(struct ubi_device *ubi, int force_scan); 797void ubi_destroy_ai(struct ubi_attach_info *ai); 798 799/* vtbl.c */ 800int ubi_change_vtbl_record(struct ubi_device *ubi, int idx, 801 struct ubi_vtbl_record *vtbl_rec); 802int ubi_vtbl_rename_volumes(struct ubi_device *ubi, 803 struct list_head *rename_list); 804int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_attach_info *ai); 805 806/* vmt.c */ 807int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req); 808int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl); 809int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs); 810int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list); 811int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol); 812void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol); 813 814/* upd.c */ 815int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol, 816 long long bytes); 817int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol, 818 const void __user *buf, int count); 819int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol, 820 const struct ubi_leb_change_req *req); 821int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol, 822 const void __user *buf, int count); 823 824/* misc.c */ 825int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf, 826 int length); 827int ubi_check_volume(struct ubi_device *ubi, int vol_id); 828void ubi_update_reserved(struct ubi_device *ubi); 829void ubi_calculate_reserved(struct ubi_device *ubi); 830int ubi_check_pattern(const void *buf, uint8_t patt, int size); 831 832/* gluebi.c */ 833#ifdef CONFIG_MTD_UBI_GLUEBI 834int ubi_create_gluebi(struct ubi_device *ubi, struct ubi_volume *vol); 835int ubi_destroy_gluebi(struct ubi_volume *vol); 836void ubi_gluebi_updated(struct ubi_volume *vol); 837#else 838#define ubi_create_gluebi(ubi, vol) 0 839 840static inline int ubi_destroy_gluebi(struct ubi_volume *vol) 841{ 842 return 0; 843} 844 845#define ubi_gluebi_updated(vol) 846#endif 847 848/* eba.c */ 849int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol, 850 int lnum); 851int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum, 852 void *buf, int offset, int len, int check); 853int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol, 854 struct ubi_sgl *sgl, int lnum, int offset, int len, 855 int check); 856int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum, 857 const void *buf, int offset, int len); 858int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol, 859 int lnum, const void *buf, int len, int used_ebs); 860int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol, 861 int lnum, const void *buf, int len); 862int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to, 863 struct ubi_vid_hdr *vid_hdr); 864int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai); 865unsigned long long ubi_next_sqnum(struct ubi_device *ubi); 866int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap, 867 struct ubi_attach_info *ai_scan); 868 869/* wl.c */ 870int ubi_wl_get_peb(struct ubi_device *ubi); 871int ubi_wl_put_peb(struct ubi_device *ubi, int vol_id, int lnum, 872 int pnum, int torture); 873int ubi_wl_flush(struct ubi_device *ubi, int vol_id, int lnum); 874int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum); 875int ubi_wl_init(struct ubi_device *ubi, struct ubi_attach_info *ai); 876void ubi_wl_close(struct ubi_device *ubi); 877int ubi_thread(void *u); 878struct ubi_wl_entry *ubi_wl_get_fm_peb(struct ubi_device *ubi, int anchor); 879int ubi_wl_put_fm_peb(struct ubi_device *ubi, struct ubi_wl_entry *used_e, 880 int lnum, int torture); 881int ubi_is_erase_work(struct ubi_work *wrk); 882void ubi_refill_pools(struct ubi_device *ubi); 883int ubi_ensure_anchor_pebs(struct ubi_device *ubi); 884 885/* io.c */ 886int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset, 887 int len); 888int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset, 889 int len); 890int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture); 891int ubi_io_is_bad(const struct ubi_device *ubi, int pnum); 892int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum); 893int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum, 894 struct ubi_ec_hdr *ec_hdr, int verbose); 895int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum, 896 struct ubi_ec_hdr *ec_hdr); 897int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum, 898 struct ubi_vid_hdr *vid_hdr, int verbose); 899int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum, 900 struct ubi_vid_hdr *vid_hdr); 901 902/* build.c */ 903int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, 904 int vid_hdr_offset, int max_beb_per1024); 905int ubi_detach_mtd_dev(int ubi_num, int anyway); 906struct ubi_device *ubi_get_device(int ubi_num); 907void ubi_put_device(struct ubi_device *ubi); 908struct ubi_device *ubi_get_by_major(int major); 909int ubi_major2num(int major); 910int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol, 911 int ntype); 912int ubi_notify_all(struct ubi_device *ubi, int ntype, 913 struct notifier_block *nb); 914int ubi_enumerate_volumes(struct notifier_block *nb); 915void ubi_free_internal_volumes(struct ubi_device *ubi); 916 917/* kapi.c */ 918void ubi_do_get_device_info(struct ubi_device *ubi, struct ubi_device_info *di); 919void ubi_do_get_volume_info(struct ubi_device *ubi, struct ubi_volume *vol, 920 struct ubi_volume_info *vi); 921/* scan.c */ 922int ubi_compare_lebs(struct ubi_device *ubi, const struct ubi_ainf_peb *aeb, 923 int pnum, const struct ubi_vid_hdr *vid_hdr); 924 925/* fastmap.c */ 926#ifdef CONFIG_MTD_UBI_FASTMAP 927size_t ubi_calc_fm_size(struct ubi_device *ubi); 928int ubi_update_fastmap(struct ubi_device *ubi); 929int ubi_scan_fastmap(struct ubi_device *ubi, struct ubi_attach_info *ai, 930 int fm_anchor); 931#else 932static inline int ubi_update_fastmap(struct ubi_device *ubi) { return 0; } 933#endif 934 935/* block.c */ 936#ifdef CONFIG_MTD_UBI_BLOCK 937int ubiblock_init(void); 938void ubiblock_exit(void); 939int ubiblock_create(struct ubi_volume_info *vi); 940int ubiblock_remove(struct ubi_volume_info *vi); 941#else 942static inline int ubiblock_init(void) { return 0; } 943static inline void ubiblock_exit(void) {} 944static inline int ubiblock_create(struct ubi_volume_info *vi) 945{ 946 return -ENOSYS; 947} 948static inline int ubiblock_remove(struct ubi_volume_info *vi) 949{ 950 return -ENOSYS; 951} 952#endif 953 954/* 955 * ubi_for_each_free_peb - walk the UBI free RB tree. 956 * @ubi: UBI device description object 957 * @e: a pointer to a ubi_wl_entry to use as cursor 958 * @pos: a pointer to RB-tree entry type to use as a loop counter 959 */ 960#define ubi_for_each_free_peb(ubi, e, tmp_rb) \ 961 ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->free, u.rb) 962 963/* 964 * ubi_for_each_used_peb - walk the UBI used RB tree. 965 * @ubi: UBI device description object 966 * @e: a pointer to a ubi_wl_entry to use as cursor 967 * @pos: a pointer to RB-tree entry type to use as a loop counter 968 */ 969#define ubi_for_each_used_peb(ubi, e, tmp_rb) \ 970 ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->used, u.rb) 971 972/* 973 * ubi_for_each_scub_peb - walk the UBI scub RB tree. 974 * @ubi: UBI device description object 975 * @e: a pointer to a ubi_wl_entry to use as cursor 976 * @pos: a pointer to RB-tree entry type to use as a loop counter 977 */ 978#define ubi_for_each_scrub_peb(ubi, e, tmp_rb) \ 979 ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->scrub, u.rb) 980 981/* 982 * ubi_for_each_protected_peb - walk the UBI protection queue. 983 * @ubi: UBI device description object 984 * @i: a integer used as counter 985 * @e: a pointer to a ubi_wl_entry to use as cursor 986 */ 987#define ubi_for_each_protected_peb(ubi, i, e) \ 988 for ((i) = 0; (i) < UBI_PROT_QUEUE_LEN; (i)++) \ 989 list_for_each_entry((e), &(ubi->pq[(i)]), u.list) 990 991/* 992 * ubi_rb_for_each_entry - walk an RB-tree. 993 * @rb: a pointer to type 'struct rb_node' to use as a loop counter 994 * @pos: a pointer to RB-tree entry type to use as a loop counter 995 * @root: RB-tree's root 996 * @member: the name of the 'struct rb_node' within the RB-tree entry 997 */ 998#define ubi_rb_for_each_entry(rb, pos, root, member) \ 999 for (rb = rb_first(root), \ 1000 pos = (rb ? container_of(rb, typeof(*pos), member) : NULL); \
1001 rb; \ 1002 rb = rb_next(rb), \ 1003 pos = (rb ? container_of(rb, typeof(*pos), member) : NULL)) 1004 1005/* 1006 * ubi_move_aeb_to_list - move a PEB from the volume tree to a list. 1007 * 1008 * @av: volume attaching information 1009 * @aeb: attaching eraseblock information 1010 * @list: the list to move to 1011 */ 1012static inline void ubi_move_aeb_to_list(struct ubi_ainf_volume *av, 1013 struct ubi_ainf_peb *aeb, 1014 struct list_head *list) 1015{ 1016 rb_erase(&aeb->u.rb, &av->root); 1017 list_add_tail(&aeb->u.list, list); 1018} 1019 1020/** 1021 * ubi_zalloc_vid_hdr - allocate a volume identifier header object. 1022 * @ubi: UBI device description object 1023 * @gfp_flags: GFP flags to allocate with 1024 * 1025 * This function returns a pointer to the newly allocated and zero-filled 1026 * volume identifier header object in case of success and %NULL in case of 1027 * failure. 1028 */ 1029static inline struct ubi_vid_hdr * 1030ubi_zalloc_vid_hdr(const struct ubi_device *ubi, gfp_t gfp_flags) 1031{ 1032 void *vid_hdr; 1033 1034 vid_hdr = kzalloc(ubi->vid_hdr_alsize, gfp_flags); 1035 if (!vid_hdr) 1036 return NULL; 1037 1038 /* 1039 * VID headers may be stored at un-aligned flash offsets, so we shift 1040 * the pointer. 1041 */ 1042 return vid_hdr + ubi->vid_hdr_shift; 1043} 1044 1045/** 1046 * ubi_free_vid_hdr - free a volume identifier header object. 1047 * @ubi: UBI device description object 1048 * @vid_hdr: the object to free 1049 */ 1050static inline void ubi_free_vid_hdr(const struct ubi_device *ubi, 1051 struct ubi_vid_hdr *vid_hdr) 1052{ 1053 void *p = vid_hdr; 1054 1055 if (!p) 1056 return; 1057 1058 kfree(p - ubi->vid_hdr_shift); 1059} 1060 1061/* 1062 * This function is equivalent to 'ubi_io_read()', but @offset is relative to 1063 * the beginning of the logical eraseblock, not to the beginning of the 1064 * physical eraseblock. 1065 */ 1066static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf, 1067 int pnum, int offset, int len) 1068{ 1069 ubi_assert(offset >= 0); 1070 return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len); 1071} 1072 1073/* 1074 * This function is equivalent to 'ubi_io_write()', but @offset is relative to 1075 * the beginning of the logical eraseblock, not to the beginning of the 1076 * physical eraseblock. 1077 */ 1078static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf, 1079 int pnum, int offset, int len) 1080{ 1081 ubi_assert(offset >= 0); 1082 return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len); 1083} 1084 1085/** 1086 * ubi_ro_mode - switch to read-only mode. 1087 * @ubi: UBI device description object 1088 */ 1089static inline void ubi_ro_mode(struct ubi_device *ubi) 1090{ 1091 if (!ubi->ro_mode) { 1092 ubi->ro_mode = 1; 1093 ubi_warn(ubi, "switch to read-only mode"); 1094 dump_stack(); 1095 } 1096} 1097 1098/** 1099 * vol_id2idx - get table index by volume ID. 1100 * @ubi: UBI device description object 1101 * @vol_id: volume ID 1102 */ 1103static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id) 1104{ 1105 if (vol_id >= UBI_INTERNAL_VOL_START) 1106 return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots; 1107 else 1108 return vol_id; 1109} 1110 1111/** 1112 * idx2vol_id - get volume ID by table index. 1113 * @ubi: UBI device description object 1114 * @idx: table index 1115 */ 1116static inline int idx2vol_id(const struct ubi_device *ubi, int idx) 1117{ 1118 if (idx >= ubi->vtbl_slots) 1119 return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START; 1120 else 1121 return idx; 1122} 1123 1124#ifdef __UBOOT__ 1125void ubi_do_worker(struct ubi_device *ubi); 1126#endif 1127#endif /* !__UBI_UBI_H__ */ 1128