1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Copyright (c) International Business Machines Corp., 2006
4 * Copyright (c) Nokia Corporation, 2006, 2007
6 * Author: Artem Bityutskiy (Битюцкий Артём)
12 #include <linux/types.h>
13 #include <linux/list.h>
14 #include <linux/rbtree.h>
15 #include <linux/sched.h>
16 #include <linux/wait.h>
17 #include <linux/mutex.h>
18 #include <linux/rwsem.h>
19 #include <linux/spinlock.h>
21 #include <linux/cdev.h>
22 #include <linux/device.h>
23 #include <linux/slab.h>
24 #include <linux/string.h>
25 #include <linux/vmalloc.h>
26 #include <linux/notifier.h>
27 #include <linux/mtd/mtd.h>
28 #include <linux/mtd/ubi.h>
29 #include <linux/pgtable.h>
31 #include "ubi-media.h"
33 /* Maximum number of supported UBI devices */
34 #define UBI_MAX_DEVICES 32
36 /* UBI name used for character devices, sysfs, etc */
37 #define UBI_NAME_STR "ubi"
41 /* Normal UBI messages */
43 void ubi_msg(const struct ubi_device *ubi, const char *fmt, ...);
45 /* UBI warning messages */
47 void ubi_warn(const struct ubi_device *ubi, const char *fmt, ...);
49 /* UBI error messages */
51 void ubi_err(const struct ubi_device *ubi, const char *fmt, ...);
53 /* Background thread name pattern */
54 #define UBI_BGT_NAME_PATTERN "ubi_bgt%dd"
57 * This marker in the EBA table means that the LEB is um-mapped.
58 * NOTE! It has to have the same value as %UBI_ALL.
60 #define UBI_LEB_UNMAPPED -1
63 * In case of errors, UBI tries to repeat the operation several times before
64 * returning error. The below constant defines how many times UBI re-tries.
66 #define UBI_IO_RETRIES 3
69 * Length of the protection queue. The length is effectively equivalent to the
70 * number of (global) erase cycles PEBs are protected from the wear-leveling
73 #define UBI_PROT_QUEUE_LEN 10
75 /* The volume ID/LEB number/erase counter is unknown */
76 #define UBI_UNKNOWN -1
79 * The UBI debugfs directory name pattern and maximum name length (3 for "ubi"
80 * + 2 for the number plus 1 for the trailing zero byte.
82 #define UBI_DFS_DIR_NAME "ubi%d"
83 #define UBI_DFS_DIR_LEN (3 + 2 + 1)
85 /* Number of physical eraseblocks reserved for atomic LEB change operation */
86 #define EBA_RESERVED_PEBS 1
89 * Error codes returned by the I/O sub-system.
91 * UBI_IO_FF: the read region of flash contains only 0xFFs
92 * UBI_IO_FF_BITFLIPS: the same as %UBI_IO_FF, but also there was a data
93 * integrity error reported by the MTD driver
94 * (uncorrectable ECC error in case of NAND)
95 * UBI_IO_BAD_HDR: the EC or VID header is corrupted (bad magic or CRC)
96 * UBI_IO_BAD_HDR_EBADMSG: the same as %UBI_IO_BAD_HDR, but also there was a
97 * data integrity error reported by the MTD driver
98 * (uncorrectable ECC error in case of NAND)
99 * UBI_IO_BITFLIPS: bit-flips were detected and corrected
101 * Note, it is probably better to have bit-flip and ebadmsg as flags which can
102 * be or'ed with other error code. But this is a big change because there are
103 * may callers, so it does not worth the risk of introducing a bug
109 UBI_IO_BAD_HDR_EBADMSG,
114 * Return codes of the 'ubi_eba_copy_leb()' function.
116 * MOVE_CANCEL_RACE: canceled because the volume is being deleted, the source
117 * PEB was put meanwhile, or there is I/O on the source PEB
118 * MOVE_SOURCE_RD_ERR: canceled because there was a read error from the source
120 * MOVE_TARGET_RD_ERR: canceled because there was a read error from the target
122 * MOVE_TARGET_WR_ERR: canceled because there was a write error to the target
124 * MOVE_TARGET_BITFLIPS: canceled because a bit-flip was detected in the
126 * MOVE_RETRY: retry scrubbing the PEB
129 MOVE_CANCEL_RACE = 1,
133 MOVE_TARGET_BITFLIPS,
138 * Return codes of the fastmap sub-system
140 * UBI_NO_FASTMAP: No fastmap super block was found
141 * UBI_BAD_FASTMAP: A fastmap was found but it's unusable
149 * struct ubi_vid_io_buf - VID buffer used to read/write VID info to/from the
151 * @hdr: a pointer to the VID header stored in buffer
152 * @buffer: underlying buffer
154 struct ubi_vid_io_buf {
155 struct ubi_vid_hdr *hdr;
160 * struct ubi_wl_entry - wear-leveling entry.
161 * @u.rb: link in the corresponding (free/used) RB-tree
162 * @u.list: link in the protection queue
164 * @pnum: physical eraseblock number
166 * This data structure is used in the WL sub-system. Each physical eraseblock
167 * has a corresponding &struct wl_entry object which may be kept in different
168 * RB-trees. See WL sub-system for details.
170 struct ubi_wl_entry {
173 struct list_head list;
180 * struct ubi_ltree_entry - an entry in the lock tree.
181 * @rb: links RB-tree nodes
182 * @vol_id: volume ID of the locked logical eraseblock
183 * @lnum: locked logical eraseblock number
184 * @users: how many tasks are using this logical eraseblock or wait for it
185 * @mutex: read/write mutex to implement read/write access serialization to
186 * the (@vol_id, @lnum) logical eraseblock
188 * This data structure is used in the EBA sub-system to implement per-LEB
189 * locking. When a logical eraseblock is being locked - corresponding
190 * &struct ubi_ltree_entry object is inserted to the lock tree (@ubi->ltree).
191 * See EBA sub-system for details.
193 struct ubi_ltree_entry {
198 struct rw_semaphore mutex;
202 * struct ubi_rename_entry - volume re-name description data structure.
203 * @new_name_len: new volume name length
204 * @new_name: new volume name
205 * @remove: if not zero, this volume should be removed, not re-named
206 * @desc: descriptor of the volume
207 * @list: links re-name entries into a list
209 * This data structure is utilized in the multiple volume re-name code. Namely,
210 * UBI first creates a list of &struct ubi_rename_entry objects from the
211 * &struct ubi_rnvol_req request object, and then utilizes this list to do all
214 struct ubi_rename_entry {
216 char new_name[UBI_VOL_NAME_MAX + 1];
218 struct ubi_volume_desc *desc;
219 struct list_head list;
222 struct ubi_volume_desc;
225 * struct ubi_fastmap_layout - in-memory fastmap data structure.
226 * @e: PEBs used by the current fastmap
227 * @to_be_tortured: if non-zero tortured this PEB
228 * @used_blocks: number of used PEBs
229 * @max_pool_size: maximal size of the user pool
230 * @max_wl_pool_size: maximal size of the pool used by the WL sub-system
232 struct ubi_fastmap_layout {
233 struct ubi_wl_entry *e[UBI_FM_MAX_BLOCKS];
234 int to_be_tortured[UBI_FM_MAX_BLOCKS];
237 int max_wl_pool_size;
241 * struct ubi_fm_pool - in-memory fastmap pool
242 * @pebs: PEBs in this pool
243 * @used: number of used PEBs
244 * @size: total number of PEBs in this pool
245 * @max_size: maximal size of the pool
247 * A pool gets filled with up to max_size.
248 * If all PEBs within the pool are used a new fastmap will be written
249 * to the flash and the pool gets refilled with empty PEBs.
253 int pebs[UBI_FM_MAX_POOL_SIZE];
260 * struct ubi_eba_leb_desc - EBA logical eraseblock descriptor
261 * @lnum: the logical eraseblock number
262 * @pnum: the physical eraseblock where the LEB can be found
264 * This structure is here to hide EBA's internal from other part of the
265 * UBI implementation.
267 * One can query the position of a LEB by calling ubi_eba_get_ldesc().
269 struct ubi_eba_leb_desc {
275 * struct ubi_volume - UBI volume description data structure.
276 * @dev: device object to make use of the Linux device model
277 * @cdev: character device object to create character device
278 * @ubi: reference to the UBI device description object
280 * @ref_count: volume reference count
281 * @readers: number of users holding this volume in read-only mode
282 * @writers: number of users holding this volume in read-write mode
283 * @exclusive: whether somebody holds this volume in exclusive mode
284 * @metaonly: whether somebody is altering only meta data of this volume
286 * @reserved_pebs: how many physical eraseblocks are reserved for this volume
287 * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
288 * @usable_leb_size: logical eraseblock size without padding
289 * @used_ebs: how many logical eraseblocks in this volume contain data
290 * @last_eb_bytes: how many bytes are stored in the last logical eraseblock
291 * @used_bytes: how many bytes of data this volume contains
292 * @alignment: volume alignment
293 * @data_pad: how many bytes are not used at the end of physical eraseblocks to
294 * satisfy the requested alignment
295 * @name_len: volume name length
298 * @upd_ebs: how many eraseblocks are expected to be updated
299 * @ch_lnum: LEB number which is being changing by the atomic LEB change
301 * @upd_bytes: how many bytes are expected to be received for volume update or
303 * @upd_received: how many bytes were already received for volume update or
305 * @upd_buf: update buffer which is used to collect update data or data for
308 * @eba_tbl: EBA table of this volume (LEB->PEB mapping)
309 * @skip_check: %1 if CRC check of this static volume should be skipped.
310 * Directly reflects the presence of the
311 * %UBI_VTBL_SKIP_CRC_CHECK_FLG flag in the vtbl entry
312 * @checked: %1 if this static volume was checked
313 * @corrupted: %1 if the volume is corrupted (static volumes only)
314 * @upd_marker: %1 if the update marker is set for this volume
315 * @updating: %1 if the volume is being updated
316 * @changing_leb: %1 if the atomic LEB change ioctl command is in progress
317 * @direct_writes: %1 if direct writes are enabled for this volume
319 * @checkmap: bitmap to remember which PEB->LEB mappings got checked,
320 * protected by UBI LEB lock tree.
322 * The @corrupted field indicates that the volume's contents is corrupted.
323 * Since UBI protects only static volumes, this field is not relevant to
324 * dynamic volumes - it is user's responsibility to assure their data
327 * The @upd_marker flag indicates that this volume is either being updated at
328 * the moment or is damaged because of an unclean reboot.
333 struct ubi_device *ubi;
346 long long used_bytes;
350 char name[UBI_VOL_NAME_MAX + 1];
355 long long upd_received;
358 struct ubi_eba_table *eba_tbl;
359 unsigned int skip_check:1;
360 unsigned int checked:1;
361 unsigned int corrupted:1;
362 unsigned int upd_marker:1;
363 unsigned int updating:1;
364 unsigned int changing_leb:1;
365 unsigned int direct_writes:1;
367 #ifdef CONFIG_MTD_UBI_FASTMAP
368 unsigned long *checkmap;
373 * struct ubi_volume_desc - UBI volume descriptor returned when it is opened.
374 * @vol: reference to the corresponding volume description object
375 * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, %UBI_EXCLUSIVE
378 struct ubi_volume_desc {
379 struct ubi_volume *vol;
384 * struct ubi_debug_info - debugging information for an UBI device.
386 * @chk_gen: if UBI general extra checks are enabled
387 * @chk_io: if UBI I/O extra checks are enabled
388 * @chk_fastmap: if UBI fastmap extra checks are enabled
389 * @disable_bgt: disable the background task for testing purposes
390 * @emulate_bitflips: emulate bit-flips for testing purposes
391 * @emulate_io_failures: emulate write/erase failures for testing purposes
392 * @emulate_power_cut: emulate power cut for testing purposes
393 * @power_cut_counter: count down for writes left until emulated power cut
394 * @power_cut_min: minimum number of writes before emulating a power cut
395 * @power_cut_max: maximum number of writes until emulating a power cut
396 * @emulate_failures: emulate failures for testing purposes
397 * @dfs_dir_name: name of debugfs directory containing files of this UBI device
398 * @dfs_dir: direntry object of the UBI device debugfs directory
399 * @dfs_chk_gen: debugfs knob to enable UBI general extra checks
400 * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks
401 * @dfs_chk_fastmap: debugfs knob to enable UBI fastmap extra checks
402 * @dfs_disable_bgt: debugfs knob to disable the background task
403 * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips
404 * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures
405 * @dfs_emulate_power_cut: debugfs knob to emulate power cuts
406 * @dfs_power_cut_min: debugfs knob for minimum writes before power cut
407 * @dfs_power_cut_max: debugfs knob for maximum writes until power cut
408 * @dfs_emulate_failures: debugfs entry to control the fault injection type
410 struct ubi_debug_info {
411 unsigned int chk_gen:1;
412 unsigned int chk_io:1;
413 unsigned int chk_fastmap:1;
414 unsigned int disable_bgt:1;
415 unsigned int emulate_bitflips:1;
416 unsigned int emulate_io_failures:1;
417 unsigned int emulate_power_cut:2;
418 unsigned int power_cut_counter;
419 unsigned int power_cut_min;
420 unsigned int power_cut_max;
421 unsigned int emulate_failures;
422 char dfs_dir_name[UBI_DFS_DIR_LEN + 1];
423 struct dentry *dfs_dir;
424 struct dentry *dfs_chk_gen;
425 struct dentry *dfs_chk_io;
426 struct dentry *dfs_chk_fastmap;
427 struct dentry *dfs_disable_bgt;
428 struct dentry *dfs_emulate_bitflips;
429 struct dentry *dfs_emulate_io_failures;
430 struct dentry *dfs_emulate_power_cut;
431 struct dentry *dfs_power_cut_min;
432 struct dentry *dfs_power_cut_max;
433 struct dentry *dfs_emulate_failures;
437 * struct ubi_device - UBI device description structure
438 * @dev: UBI device object to use the Linux device model
439 * @cdev: character device object to create character device
440 * @ubi_num: UBI device number
441 * @ubi_name: UBI device name
442 * @vol_count: number of volumes in this UBI device
443 * @volumes: volumes of this UBI device
444 * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs,
445 * @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count,
446 * @vol->readers, @vol->writers, @vol->exclusive,
447 * @vol->metaonly, @vol->ref_count, @vol->mapping and
449 * @ref_count: count of references on the UBI device
450 * @image_seq: image sequence number recorded on EC headers
452 * @rsvd_pebs: count of reserved physical eraseblocks
453 * @avail_pebs: count of available physical eraseblocks
454 * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB
456 * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling
458 * @autoresize_vol_id: ID of the volume which has to be auto-resized at the end
459 * of UBI initialization
460 * @vtbl_slots: how many slots are available in the volume table
461 * @vtbl_size: size of the volume table in bytes
462 * @vtbl: in-RAM volume table copy
463 * @device_mutex: protects on-flash volume table and serializes volume
464 * creation, deletion, update, re-size, re-name and set
467 * @max_ec: current highest erase counter value
468 * @mean_ec: current mean erase counter value
470 * @global_sqnum: global sequence number
471 * @ltree_lock: protects the lock tree and @global_sqnum
472 * @ltree: the lock tree
473 * @alc_mutex: serializes "atomic LEB change" operations
475 * @fm_disabled: non-zero if fastmap is disabled (default)
476 * @fm: in-memory data structure of the currently used fastmap
477 * @fm_pool: in-memory data structure of the fastmap pool
478 * @fm_wl_pool: in-memory data structure of the fastmap pool used by the WL
480 * @fm_protect: serializes ubi_update_fastmap(), protects @fm_buf and makes sure
481 * that critical sections cannot be interrupted by ubi_update_fastmap()
482 * @fm_buf: vmalloc()'d buffer which holds the raw fastmap
483 * @fm_size: fastmap size in bytes
484 * @fm_eba_sem: allows ubi_update_fastmap() to block EBA table changes
485 * @fm_work: fastmap work queue
486 * @fm_work_scheduled: non-zero if fastmap work was scheduled
487 * @fast_attach: non-zero if UBI was attached by fastmap
488 * @fm_anchor: The next anchor PEB to use for fastmap
489 * @fm_do_produce_anchor: If true produce an anchor PEB in wl
490 * @fm_pool_rsv_cnt: Number of reserved PEBs for filling pool/wl_pool
492 * @used: RB-tree of used physical eraseblocks
493 * @erroneous: RB-tree of erroneous used physical eraseblocks
494 * @free: RB-tree of free physical eraseblocks
495 * @free_count: Contains the number of elements in @free
496 * @scrub: RB-tree of physical eraseblocks which need scrubbing
497 * @pq: protection queue (contain physical eraseblocks which are temporarily
498 * protected from the wear-leveling worker)
499 * @pq_head: protection queue head
500 * @wl_lock: protects the @used, @free, @pq, @pq_head, @lookuptbl, @move_from,
501 * @move_to, @move_to_put @erase_pending, @wl_scheduled, @works,
502 * @erroneous, @erroneous_peb_count, @fm_work_scheduled, @fm_pool,
503 * and @fm_wl_pool fields
504 * @move_mutex: serializes eraseblock moves
505 * @work_sem: used to wait for all the scheduled works to finish and prevent
506 * new works from being submitted
507 * @wl_scheduled: non-zero if the wear-leveling was scheduled
508 * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
509 * physical eraseblock
510 * @move_from: physical eraseblock from where the data is being moved
511 * @move_to: physical eraseblock where the data is being moved to
512 * @move_to_put: if the "to" PEB was put
513 * @works: list of pending works
514 * @works_count: count of pending works
515 * @bgt_thread: background thread description object
516 * @thread_enabled: if the background thread is enabled
517 * @bgt_name: background thread name
519 * @flash_size: underlying MTD device size (in bytes)
520 * @peb_count: count of physical eraseblocks on the MTD device
521 * @peb_size: physical eraseblock size
522 * @bad_peb_limit: top limit of expected bad physical eraseblocks
523 * @bad_peb_count: count of bad physical eraseblocks
524 * @good_peb_count: count of good physical eraseblocks
525 * @corr_peb_count: count of corrupted physical eraseblocks (preserved and not
527 * @erroneous_peb_count: count of erroneous physical eraseblocks in @erroneous
528 * @max_erroneous: maximum allowed amount of erroneous physical eraseblocks
529 * @min_io_size: minimal input/output unit size of the underlying MTD device
530 * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers
531 * @ro_mode: if the UBI device is in read-only mode
532 * @leb_size: logical eraseblock size
533 * @leb_start: starting offset of logical eraseblocks within physical
535 * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size
536 * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size
537 * @vid_hdr_offset: starting offset of the volume identifier header (might be
539 * @vid_hdr_aloffset: starting offset of the VID header aligned to
541 * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset
542 * @bad_allowed: whether the MTD device admits bad physical eraseblocks or not
543 * @nor_flash: non-zero if working on top of NOR flash
544 * @max_write_size: maximum amount of bytes the underlying flash can write at a
545 * time (MTD write buffer size)
546 * @mtd: MTD device descriptor
548 * @peb_buf: a buffer of PEB size used for different purposes
549 * @buf_mutex: protects @peb_buf
550 * @ckvol_mutex: serializes static volume checking when opening
552 * @dbg: debugging information for this UBI device
558 char ubi_name[sizeof(UBI_NAME_STR)+5];
560 struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT];
561 spinlock_t volumes_lock;
571 int autoresize_vol_id;
574 struct ubi_vtbl_record *vtbl;
575 struct mutex device_mutex;
578 /* Note, mean_ec is not updated run-time - should be fixed */
581 /* EBA sub-system's stuff */
582 unsigned long long global_sqnum;
583 spinlock_t ltree_lock;
584 struct rb_root ltree;
585 struct mutex alc_mutex;
589 struct ubi_fastmap_layout *fm;
590 struct ubi_fm_pool fm_pool;
591 struct ubi_fm_pool fm_wl_pool;
592 struct rw_semaphore fm_eba_sem;
593 struct rw_semaphore fm_protect;
596 struct work_struct fm_work;
597 int fm_work_scheduled;
599 struct ubi_wl_entry *fm_anchor;
600 int fm_do_produce_anchor;
603 /* Wear-leveling sub-system's stuff */
605 struct rb_root erroneous;
608 struct rb_root scrub;
609 struct list_head pq[UBI_PROT_QUEUE_LEN];
612 struct mutex move_mutex;
613 struct rw_semaphore work_sem;
615 struct ubi_wl_entry **lookuptbl;
616 struct ubi_wl_entry *move_from;
617 struct ubi_wl_entry *move_to;
619 struct list_head works;
621 struct task_struct *bgt_thread;
623 char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2];
625 /* I/O sub-system's stuff */
626 long long flash_size;
632 int erroneous_peb_count;
635 int hdrs_min_io_size;
642 int vid_hdr_aloffset;
644 unsigned int bad_allowed:1;
645 unsigned int nor_flash:1;
647 struct mtd_info *mtd;
650 struct mutex buf_mutex;
651 struct mutex ckvol_mutex;
653 struct ubi_debug_info dbg;
657 * struct ubi_ainf_peb - attach information about a physical eraseblock.
658 * @ec: erase counter (%UBI_UNKNOWN if it is unknown)
659 * @pnum: physical eraseblock number
660 * @vol_id: ID of the volume this LEB belongs to
661 * @lnum: logical eraseblock number
662 * @scrub: if this physical eraseblock needs scrubbing
663 * @copy_flag: this LEB is a copy (@copy_flag is set in VID header of this LEB)
664 * @sqnum: sequence number
665 * @u: unions RB-tree or @list links
666 * @u.rb: link in the per-volume RB-tree of &struct ubi_ainf_peb objects
667 * @u.list: link in one of the eraseblock lists
669 * One object of this type is allocated for each physical eraseblock when
670 * attaching an MTD device. Note, if this PEB does not belong to any LEB /
671 * volume, the @vol_id and @lnum fields are initialized to %UBI_UNKNOWN.
673 struct ubi_ainf_peb {
678 unsigned int scrub:1;
679 unsigned int copy_flag:1;
680 unsigned long long sqnum;
683 struct list_head list;
688 * struct ubi_ainf_volume - attaching information about a volume.
690 * @highest_lnum: highest logical eraseblock number in this volume
691 * @leb_count: number of logical eraseblocks in this volume
692 * @vol_type: volume type
693 * @used_ebs: number of used logical eraseblocks in this volume (only for
695 * @last_data_size: amount of data in the last logical eraseblock of this
696 * volume (always equivalent to the usable logical eraseblock
697 * size in case of dynamic volumes)
698 * @data_pad: how many bytes at the end of logical eraseblocks of this volume
699 * are not used (due to volume alignment)
700 * @compat: compatibility flags of this volume
701 * @rb: link in the volume RB-tree
702 * @root: root of the RB-tree containing all the eraseblock belonging to this
703 * volume (&struct ubi_ainf_peb objects)
705 * One object of this type is allocated for each volume when attaching an MTD
708 struct ubi_ainf_volume {
722 * struct ubi_attach_info - MTD device attaching information.
723 * @volumes: root of the volume RB-tree
724 * @corr: list of corrupted physical eraseblocks
725 * @free: list of free physical eraseblocks
726 * @erase: list of physical eraseblocks which have to be erased
727 * @alien: list of physical eraseblocks which should not be used by UBI (e.g.,
728 * those belonging to "preserve"-compatible internal volumes)
729 * @fastmap: list of physical eraseblocks which relate to fastmap (e.g.,
730 * eraseblocks of the current and not yet erased old fastmap blocks)
731 * @corr_peb_count: count of PEBs in the @corr list
732 * @empty_peb_count: count of PEBs which are presumably empty (contain only
734 * @alien_peb_count: count of PEBs in the @alien list
735 * @bad_peb_count: count of bad physical eraseblocks
736 * @maybe_bad_peb_count: count of bad physical eraseblocks which are not marked
737 * as bad yet, but which look like bad
738 * @vols_found: number of volumes found
739 * @highest_vol_id: highest volume ID
740 * @is_empty: flag indicating whether the MTD device is empty or not
741 * @force_full_scan: flag indicating whether we need to do a full scan and drop
742 all existing Fastmap data structures
743 * @min_ec: lowest erase counter value
744 * @max_ec: highest erase counter value
745 * @max_sqnum: highest sequence number value
746 * @mean_ec: mean erase counter value
747 * @ec_sum: a temporary variable used when calculating @mean_ec
748 * @ec_count: a temporary variable used when calculating @mean_ec
749 * @aeb_slab_cache: slab cache for &struct ubi_ainf_peb objects
750 * @ech: temporary EC header. Only available during scan
751 * @vidh: temporary VID buffer. Only available during scan
753 * This data structure contains the result of attaching an MTD device and may
754 * be used by other UBI sub-systems to build final UBI data structures, further
755 * error-recovery and so on.
757 struct ubi_attach_info {
758 struct rb_root volumes;
759 struct list_head corr;
760 struct list_head free;
761 struct list_head erase;
762 struct list_head alien;
763 struct list_head fastmap;
768 int maybe_bad_peb_count;
775 unsigned long long max_sqnum;
779 struct kmem_cache *aeb_slab_cache;
780 struct ubi_ec_hdr *ech;
781 struct ubi_vid_io_buf *vidb;
785 * struct ubi_work - UBI work description data structure.
786 * @list: a link in the list of pending works
787 * @func: worker function
788 * @e: physical eraseblock to erase
789 * @vol_id: the volume ID on which this erasure is being performed
790 * @lnum: the logical eraseblock number
791 * @torture: if the physical eraseblock has to be tortured
793 * The @func pointer points to the worker function. If the @shutdown argument is
794 * not zero, the worker has to free the resources and exit immediately as the
795 * WL sub-system is shutting down.
796 * The worker has to return zero in case of success and a negative error code in
800 struct list_head list;
801 int (*func)(struct ubi_device *ubi, struct ubi_work *wrk, int shutdown);
802 /* The below fields are only relevant to erasure works */
803 struct ubi_wl_entry *e;
811 extern struct kmem_cache *ubi_wl_entry_slab;
812 extern const struct file_operations ubi_ctrl_cdev_operations;
813 extern const struct file_operations ubi_cdev_operations;
814 extern const struct file_operations ubi_vol_cdev_operations;
815 extern struct class ubi_class;
816 extern struct mutex ubi_devices_mutex;
817 extern struct blocking_notifier_head ubi_notifiers;
820 struct ubi_ainf_peb *ubi_alloc_aeb(struct ubi_attach_info *ai, int pnum,
822 void ubi_free_aeb(struct ubi_attach_info *ai, struct ubi_ainf_peb *aeb);
823 int ubi_add_to_av(struct ubi_device *ubi, struct ubi_attach_info *ai, int pnum,
824 int ec, const struct ubi_vid_hdr *vid_hdr, int bitflips);
825 struct ubi_ainf_volume *ubi_add_av(struct ubi_attach_info *ai, int vol_id);
826 struct ubi_ainf_volume *ubi_find_av(const struct ubi_attach_info *ai,
828 void ubi_remove_av(struct ubi_attach_info *ai, struct ubi_ainf_volume *av);
829 struct ubi_ainf_peb *ubi_early_get_peb(struct ubi_device *ubi,
830 struct ubi_attach_info *ai);
831 int ubi_attach(struct ubi_device *ubi, int force_scan);
832 void ubi_destroy_ai(struct ubi_attach_info *ai);
835 int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
836 struct ubi_vtbl_record *vtbl_rec);
837 int ubi_vtbl_rename_volumes(struct ubi_device *ubi,
838 struct list_head *rename_list);
839 int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_attach_info *ai);
842 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req);
843 int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl);
844 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs);
845 int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list);
846 int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol);
847 void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol);
850 int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol,
852 int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol,
853 const void __user *buf, int count);
854 int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
855 const struct ubi_leb_change_req *req);
856 int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol,
857 const void __user *buf, int count);
860 int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf,
862 int ubi_check_volume(struct ubi_device *ubi, int vol_id);
863 void ubi_update_reserved(struct ubi_device *ubi);
864 void ubi_calculate_reserved(struct ubi_device *ubi);
865 int ubi_check_pattern(const void *buf, uint8_t patt, int size);
867 static inline bool ubi_leb_valid(struct ubi_volume *vol, int lnum)
869 return lnum >= 0 && lnum < vol->reserved_pebs;
873 struct ubi_eba_table *ubi_eba_create_table(struct ubi_volume *vol,
875 void ubi_eba_destroy_table(struct ubi_eba_table *tbl);
876 void ubi_eba_copy_table(struct ubi_volume *vol, struct ubi_eba_table *dst,
878 void ubi_eba_replace_table(struct ubi_volume *vol, struct ubi_eba_table *tbl);
879 void ubi_eba_get_ldesc(struct ubi_volume *vol, int lnum,
880 struct ubi_eba_leb_desc *ldesc);
881 bool ubi_eba_is_mapped(struct ubi_volume *vol, int lnum);
882 int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
884 int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
885 void *buf, int offset, int len, int check);
886 int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
887 struct ubi_sgl *sgl, int lnum, int offset, int len,
889 int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
890 const void *buf, int offset, int len);
891 int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
892 int lnum, const void *buf, int len, int used_ebs);
893 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
894 int lnum, const void *buf, int len);
895 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
896 struct ubi_vid_io_buf *vidb);
897 int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
898 unsigned long long ubi_next_sqnum(struct ubi_device *ubi);
899 int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
900 struct ubi_attach_info *ai_scan);
903 int ubi_sync_erase(struct ubi_device *ubi, struct ubi_wl_entry *e, int torture);
904 int ubi_wl_get_peb(struct ubi_device *ubi);
905 int ubi_wl_put_peb(struct ubi_device *ubi, int vol_id, int lnum,
906 int pnum, int torture);
907 int ubi_wl_flush(struct ubi_device *ubi, int vol_id, int lnum);
908 int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum);
909 int ubi_wl_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
910 void ubi_wl_close(struct ubi_device *ubi);
911 int ubi_thread(void *u);
912 struct ubi_wl_entry *ubi_wl_get_fm_peb(struct ubi_device *ubi, int anchor);
913 int ubi_wl_put_fm_peb(struct ubi_device *ubi, struct ubi_wl_entry *used_e,
914 int lnum, int torture);
915 int ubi_is_erase_work(struct ubi_work *wrk);
916 void ubi_refill_pools_and_lock(struct ubi_device *ubi);
917 int ubi_ensure_anchor_pebs(struct ubi_device *ubi);
918 int ubi_bitflip_check(struct ubi_device *ubi, int pnum, int force_scrub);
921 int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
923 int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
925 int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture);
926 int ubi_io_is_bad(const struct ubi_device *ubi, int pnum);
927 int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum);
928 int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
929 struct ubi_ec_hdr *ec_hdr, int verbose);
930 int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
931 struct ubi_ec_hdr *ec_hdr);
932 int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
933 struct ubi_vid_io_buf *vidb, int verbose);
934 int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
935 struct ubi_vid_io_buf *vidb);
938 int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,
939 int vid_hdr_offset, int max_beb_per1024,
940 bool disable_fm, bool need_resv_pool);
941 int ubi_detach_mtd_dev(int ubi_num, int anyway);
942 struct ubi_device *ubi_get_device(int ubi_num);
943 void ubi_put_device(struct ubi_device *ubi);
944 struct ubi_device *ubi_get_by_major(int major);
945 int ubi_major2num(int major);
946 int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol,
948 int ubi_notify_all(struct ubi_device *ubi, int ntype,
949 struct notifier_block *nb);
950 int ubi_enumerate_volumes(struct notifier_block *nb);
951 void ubi_free_all_volumes(struct ubi_device *ubi);
952 void ubi_free_internal_volumes(struct ubi_device *ubi);
955 void ubi_do_get_device_info(struct ubi_device *ubi, struct ubi_device_info *di);
956 void ubi_do_get_volume_info(struct ubi_device *ubi, struct ubi_volume *vol,
957 struct ubi_volume_info *vi);
959 int ubi_compare_lebs(struct ubi_device *ubi, const struct ubi_ainf_peb *aeb,
960 int pnum, const struct ubi_vid_hdr *vid_hdr);
963 #ifdef CONFIG_MTD_UBI_FASTMAP
964 size_t ubi_calc_fm_size(struct ubi_device *ubi);
965 int ubi_update_fastmap(struct ubi_device *ubi);
966 int ubi_scan_fastmap(struct ubi_device *ubi, struct ubi_attach_info *ai,
967 struct ubi_attach_info *scan_ai);
968 int ubi_fastmap_init_checkmap(struct ubi_volume *vol, int leb_count);
969 void ubi_fastmap_destroy_checkmap(struct ubi_volume *vol);
971 static inline int ubi_update_fastmap(struct ubi_device *ubi) { return 0; }
972 static inline int ubi_fastmap_init_checkmap(struct ubi_volume *vol, int leb_count) { return 0; }
973 static inline void ubi_fastmap_destroy_checkmap(struct ubi_volume *vol) {}
977 #ifdef CONFIG_MTD_UBI_BLOCK
978 int ubiblock_init(void);
979 void ubiblock_exit(void);
980 int ubiblock_create(struct ubi_volume_info *vi);
981 int ubiblock_remove(struct ubi_volume_info *vi);
983 static inline int ubiblock_init(void) { return 0; }
984 static inline void ubiblock_exit(void) {}
985 static inline int ubiblock_create(struct ubi_volume_info *vi)
989 static inline int ubiblock_remove(struct ubi_volume_info *vi)
996 * ubi_for_each_free_peb - walk the UBI free RB tree.
997 * @ubi: UBI device description object
998 * @e: a pointer to a ubi_wl_entry to use as cursor
999 * @pos: a pointer to RB-tree entry type to use as a loop counter
1001 #define ubi_for_each_free_peb(ubi, e, tmp_rb) \
1002 ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->free, u.rb)
1005 * ubi_for_each_used_peb - walk the UBI used RB tree.
1006 * @ubi: UBI device description object
1007 * @e: a pointer to a ubi_wl_entry to use as cursor
1008 * @pos: a pointer to RB-tree entry type to use as a loop counter
1010 #define ubi_for_each_used_peb(ubi, e, tmp_rb) \
1011 ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->used, u.rb)
1014 * ubi_for_each_scub_peb - walk the UBI scub RB tree.
1015 * @ubi: UBI device description object
1016 * @e: a pointer to a ubi_wl_entry to use as cursor
1017 * @pos: a pointer to RB-tree entry type to use as a loop counter
1019 #define ubi_for_each_scrub_peb(ubi, e, tmp_rb) \
1020 ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->scrub, u.rb)
1023 * ubi_for_each_protected_peb - walk the UBI protection queue.
1024 * @ubi: UBI device description object
1025 * @i: a integer used as counter
1026 * @e: a pointer to a ubi_wl_entry to use as cursor
1028 #define ubi_for_each_protected_peb(ubi, i, e) \
1029 for ((i) = 0; (i) < UBI_PROT_QUEUE_LEN; (i)++) \
1030 list_for_each_entry((e), &(ubi->pq[(i)]), u.list)
1033 * ubi_rb_for_each_entry - walk an RB-tree.
1034 * @rb: a pointer to type 'struct rb_node' to use as a loop counter
1035 * @pos: a pointer to RB-tree entry type to use as a loop counter
1036 * @root: RB-tree's root
1037 * @member: the name of the 'struct rb_node' within the RB-tree entry
1039 #define ubi_rb_for_each_entry(rb, pos, root, member) \
1040 for (rb = rb_first(root), \
1041 pos = (rb ? container_of(rb, typeof(*pos), member) : NULL); \
1044 pos = (rb ? container_of(rb, typeof(*pos), member) : NULL))
1047 * ubi_move_aeb_to_list - move a PEB from the volume tree to a list.
1049 * @av: volume attaching information
1050 * @aeb: attaching eraseblock information
1051 * @list: the list to move to
1053 static inline void ubi_move_aeb_to_list(struct ubi_ainf_volume *av,
1054 struct ubi_ainf_peb *aeb,
1055 struct list_head *list)
1057 rb_erase(&aeb->u.rb, &av->root);
1058 list_add_tail(&aeb->u.list, list);
1062 * ubi_init_vid_buf - Initialize a VID buffer
1063 * @ubi: the UBI device
1064 * @vidb: the VID buffer to initialize
1065 * @buf: the underlying buffer
1067 static inline void ubi_init_vid_buf(const struct ubi_device *ubi,
1068 struct ubi_vid_io_buf *vidb,
1072 memset(buf, 0, ubi->vid_hdr_alsize);
1075 vidb->hdr = buf + ubi->vid_hdr_shift;
1079 * ubi_init_vid_buf - Allocate a VID buffer
1080 * @ubi: the UBI device
1081 * @gfp_flags: GFP flags to use for the allocation
1083 static inline struct ubi_vid_io_buf *
1084 ubi_alloc_vid_buf(const struct ubi_device *ubi, gfp_t gfp_flags)
1086 struct ubi_vid_io_buf *vidb;
1089 vidb = kzalloc(sizeof(*vidb), gfp_flags);
1093 buf = kmalloc(ubi->vid_hdr_alsize, gfp_flags);
1099 ubi_init_vid_buf(ubi, vidb, buf);
1105 * ubi_free_vid_buf - Free a VID buffer
1106 * @vidb: the VID buffer to free
1108 static inline void ubi_free_vid_buf(struct ubi_vid_io_buf *vidb)
1113 kfree(vidb->buffer);
1118 * ubi_get_vid_hdr - Get the VID header attached to a VID buffer
1121 static inline struct ubi_vid_hdr *ubi_get_vid_hdr(struct ubi_vid_io_buf *vidb)
1127 * ubi_ro_mode - switch to read-only mode.
1128 * @ubi: UBI device description object
1130 static inline void ubi_ro_mode(struct ubi_device *ubi)
1132 if (!ubi->ro_mode) {
1134 ubi_warn(ubi, "switch to read-only mode");
1140 * This function is equivalent to 'ubi_io_read()', but @offset is relative to
1141 * the beginning of the logical eraseblock, not to the beginning of the
1142 * physical eraseblock.
1144 static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf,
1145 int pnum, int offset, int len)
1147 ubi_assert(offset >= 0);
1148 return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len);
1152 * This function is equivalent to 'ubi_io_write()', but @offset is relative to
1153 * the beginning of the logical eraseblock, not to the beginning of the
1154 * physical eraseblock.
1156 static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf,
1157 int pnum, int offset, int len)
1159 ubi_assert(offset >= 0);
1161 if (ubi_dbg_power_cut(ubi, MASK_POWER_CUT_DATA)) {
1162 ubi_warn(ubi, "XXXXX emulating a power cut when writing data XXXXX");
1166 return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len);
1170 * vol_id2idx - get table index by volume ID.
1171 * @ubi: UBI device description object
1172 * @vol_id: volume ID
1174 static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id)
1176 if (vol_id >= UBI_INTERNAL_VOL_START)
1177 return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots;
1183 * idx2vol_id - get volume ID by table index.
1184 * @ubi: UBI device description object
1187 static inline int idx2vol_id(const struct ubi_device *ubi, int idx)
1189 if (idx >= ubi->vtbl_slots)
1190 return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START;
1196 * ubi_is_fm_vol - check whether a volume ID is a Fastmap volume.
1197 * @vol_id: volume ID
1199 static inline bool ubi_is_fm_vol(int vol_id)
1202 case UBI_FM_SB_VOLUME_ID:
1203 case UBI_FM_DATA_VOLUME_ID:
1211 * ubi_find_fm_block - check whether a PEB is part of the current Fastmap.
1212 * @ubi: UBI device description object
1213 * @pnum: physical eraseblock to look for
1215 * This function returns a wear leveling object if @pnum relates to the current
1216 * fastmap, @NULL otherwise.
1218 static inline struct ubi_wl_entry *ubi_find_fm_block(const struct ubi_device *ubi,
1224 for (i = 0; i < ubi->fm->used_blocks; i++) {
1225 if (ubi->fm->e[i]->pnum == pnum)
1226 return ubi->fm->e[i];
1233 #endif /* !__UBI_UBI_H__ */