801c135ce7
UBI (Latin: "where?") manages multiple logical volumes on a single flash device, specifically supporting NAND flash devices. UBI provides a flexible partitioning concept which still allows for wear-levelling across the whole flash device. In a sense, UBI may be compared to the Logical Volume Manager (LVM). Whereas LVM maps logical sector numbers to physical HDD sector numbers, UBI maps logical eraseblocks to physical eraseblocks. More information may be found at http://www.linux-mtd.infradead.org/doc/ubi.html Partitioning/Re-partitioning An UBI volume occupies a certain number of erase blocks. This is limited by a configured maximum volume size, which could also be viewed as the partition size. Each individual UBI volume's size can be changed independently of the other UBI volumes, provided that the sum of all volume sizes doesn't exceed a certain limit. UBI supports dynamic volumes and static volumes. Static volumes are read-only and their contents are protected by CRC check sums. Bad eraseblocks handling UBI transparently handles bad eraseblocks. When a physical eraseblock becomes bad, it is substituted by a good physical eraseblock, and the user does not even notice this. Scrubbing On a NAND flash bit flips can occur on any write operation, sometimes also on read. If bit flips persist on the device, at first they can still be corrected by ECC, but once they accumulate, correction will become impossible. Thus it is best to actively scrub the affected eraseblock, by first copying it to a free eraseblock and then erasing the original. The UBI layer performs this type of scrubbing under the covers, transparently to the UBI volume users. Erase Counts UBI maintains an erase count header per eraseblock. This frees higher-level layers (like file systems) from doing this and allows for centralized erase count management instead. The erase counts are used by the wear-levelling algorithm in the UBI layer. The algorithm itself is exchangeable. Booting from NAND For booting directly from NAND flash the hardware must at least be capable of fetching and executing a small portion of the NAND flash. Some NAND flash controllers have this kind of support. They usually limit the window to a few kilobytes in erase block 0. This "initial program loader" (IPL) must then contain sufficient logic to load and execute the next boot phase. Due to bad eraseblocks, which may be randomly scattered over the flash device, it is problematic to store the "secondary program loader" (SPL) statically. Also, due to bit-flips it may become corrupted over time. UBI allows to solve this problem gracefully by storing the SPL in a small static UBI volume. UBI volumes vs. static partitions UBI volumes are still very similar to static MTD partitions: * both consist of eraseblocks (logical eraseblocks in case of UBI volumes, and physical eraseblocks in case of static partitions; * both support three basic operations - read, write, erase. But UBI volumes have the following advantages over traditional static MTD partitions: * there are no eraseblock wear-leveling constraints in case of UBI volumes, so the user should not care about this; * there are no bit-flips and bad eraseblocks in case of UBI volumes. So, UBI volumes may be considered as flash devices with relaxed restrictions. Where can it be found? Documentation, kernel code and applications can be found in the MTD gits. What are the applications for? The applications help to create binary flash images for two purposes: pfi files (partial flash images) for in-system update of UBI volumes, and plain binary images, with or without OOB data in case of NAND, for a manufacturing step. Furthermore some tools are/and will be created that allow flash content analysis after a system has crashed.. Who did UBI? The original ideas, where UBI is based on, were developed by Andreas Arnez, Frank Haverkamp and Thomas Gleixner. Josh W. Boyer and some others were involved too. The implementation of the kernel layer was done by Artem B. Bityutskiy. The user-space applications and tools were written by Oliver Lohmann with contributions from Frank Haverkamp, Andreas Arnez, and Artem. Joern Engel contributed a patch which modifies JFFS2 so that it can be run on a UBI volume. Thomas Gleixner did modifications to the NAND layer. Alexander Schmidt made some testing work as well as core functionality improvements. Signed-off-by: Artem B. Bityutskiy <dedekind@linutronix.de> Signed-off-by: Frank Haverkamp <haver@vnet.ibm.com>
167 lines
5.6 KiB
C
167 lines
5.6 KiB
C
/*
|
|
* Copyright (c) International Business Machines Corp., 2006
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
|
|
* the GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*
|
|
* Author: Artem Bityutskiy (Битюцкий Артём)
|
|
*/
|
|
|
|
#ifndef __UBI_SCAN_H__
|
|
#define __UBI_SCAN_H__
|
|
|
|
/* The erase counter value for this physical eraseblock is unknown */
|
|
#define UBI_SCAN_UNKNOWN_EC (-1)
|
|
|
|
/**
|
|
* struct ubi_scan_leb - scanning information about a physical eraseblock.
|
|
* @ec: erase counter (%UBI_SCAN_UNKNOWN_EC if it is unknown)
|
|
* @pnum: physical eraseblock number
|
|
* @lnum: logical eraseblock number
|
|
* @scrub: if this physical eraseblock needs scrubbing
|
|
* @sqnum: sequence number
|
|
* @u: unions RB-tree or @list links
|
|
* @u.rb: link in the per-volume RB-tree of &struct ubi_scan_leb objects
|
|
* @u.list: link in one of the eraseblock lists
|
|
* @leb_ver: logical eraseblock version (obsolete)
|
|
*
|
|
* One object of this type is allocated for each physical eraseblock during
|
|
* scanning.
|
|
*/
|
|
struct ubi_scan_leb {
|
|
int ec;
|
|
int pnum;
|
|
int lnum;
|
|
int scrub;
|
|
unsigned long long sqnum;
|
|
union {
|
|
struct rb_node rb;
|
|
struct list_head list;
|
|
} u;
|
|
uint32_t leb_ver;
|
|
};
|
|
|
|
/**
|
|
* struct ubi_scan_volume - scanning information about a volume.
|
|
* @vol_id: volume ID
|
|
* @highest_lnum: highest logical eraseblock number in this volume
|
|
* @leb_count: number of logical eraseblocks in this volume
|
|
* @vol_type: volume type
|
|
* @used_ebs: number of used logical eraseblocks in this volume (only for
|
|
* static volumes)
|
|
* @last_data_size: amount of data in the last logical eraseblock of this
|
|
* volume (always equivalent to the usable logical eraseblock size in case of
|
|
* dynamic volumes)
|
|
* @data_pad: how many bytes at the end of logical eraseblocks of this volume
|
|
* are not used (due to volume alignment)
|
|
* @compat: compatibility flags of this volume
|
|
* @rb: link in the volume RB-tree
|
|
* @root: root of the RB-tree containing all the eraseblock belonging to this
|
|
* volume (&struct ubi_scan_leb objects)
|
|
*
|
|
* One object of this type is allocated for each volume during scanning.
|
|
*/
|
|
struct ubi_scan_volume {
|
|
int vol_id;
|
|
int highest_lnum;
|
|
int leb_count;
|
|
int vol_type;
|
|
int used_ebs;
|
|
int last_data_size;
|
|
int data_pad;
|
|
int compat;
|
|
struct rb_node rb;
|
|
struct rb_root root;
|
|
};
|
|
|
|
/**
|
|
* struct ubi_scan_info - UBI scanning information.
|
|
* @volumes: root of the volume RB-tree
|
|
* @corr: list of corrupted physical eraseblocks
|
|
* @free: list of free physical eraseblocks
|
|
* @erase: list of physical eraseblocks which have to be erased
|
|
* @alien: list of physical eraseblocks which should not be used by UBI (e.g.,
|
|
* @bad_peb_count: count of bad physical eraseblocks
|
|
* those belonging to "preserve"-compatible internal volumes)
|
|
* @vols_found: number of volumes found during scanning
|
|
* @highest_vol_id: highest volume ID
|
|
* @alien_peb_count: count of physical eraseblocks in the @alien list
|
|
* @is_empty: flag indicating whether the MTD device is empty or not
|
|
* @min_ec: lowest erase counter value
|
|
* @max_ec: highest erase counter value
|
|
* @max_sqnum: highest sequence number value
|
|
* @mean_ec: mean erase counter value
|
|
* @ec_sum: a temporary variable used when calculating @mean_ec
|
|
* @ec_count: a temporary variable used when calculating @mean_ec
|
|
*
|
|
* This data structure contains the result of scanning and may be used by other
|
|
* UBI units to build final UBI data structures, further error-recovery and so
|
|
* on.
|
|
*/
|
|
struct ubi_scan_info {
|
|
struct rb_root volumes;
|
|
struct list_head corr;
|
|
struct list_head free;
|
|
struct list_head erase;
|
|
struct list_head alien;
|
|
int bad_peb_count;
|
|
int vols_found;
|
|
int highest_vol_id;
|
|
int alien_peb_count;
|
|
int is_empty;
|
|
int min_ec;
|
|
int max_ec;
|
|
unsigned long long max_sqnum;
|
|
int mean_ec;
|
|
int ec_sum;
|
|
int ec_count;
|
|
};
|
|
|
|
struct ubi_device;
|
|
struct ubi_vid_hdr;
|
|
|
|
/*
|
|
* ubi_scan_move_to_list - move a physical eraseblock from the volume tree to a
|
|
* list.
|
|
*
|
|
* @sv: volume scanning information
|
|
* @seb: scanning eraseblock infprmation
|
|
* @list: the list to move to
|
|
*/
|
|
static inline void ubi_scan_move_to_list(struct ubi_scan_volume *sv,
|
|
struct ubi_scan_leb *seb,
|
|
struct list_head *list)
|
|
{
|
|
rb_erase(&seb->u.rb, &sv->root);
|
|
list_add_tail(&seb->u.list, list);
|
|
}
|
|
|
|
int ubi_scan_add_to_list(struct ubi_scan_info *si, int pnum, int ec,
|
|
struct list_head *list);
|
|
int ubi_scan_add_used(const struct ubi_device *ubi, struct ubi_scan_info *si,
|
|
int pnum, int ec, const struct ubi_vid_hdr *vid_hdr,
|
|
int bitflips);
|
|
struct ubi_scan_volume *ubi_scan_find_sv(const struct ubi_scan_info *si,
|
|
int vol_id);
|
|
struct ubi_scan_leb *ubi_scan_find_seb(const struct ubi_scan_volume *sv,
|
|
int lnum);
|
|
void ubi_scan_rm_volume(struct ubi_scan_info *si, struct ubi_scan_volume *sv);
|
|
struct ubi_scan_leb *ubi_scan_get_free_peb(const struct ubi_device *ubi,
|
|
struct ubi_scan_info *si);
|
|
int ubi_scan_erase_peb(const struct ubi_device *ubi,
|
|
const struct ubi_scan_info *si, int pnum, int ec);
|
|
struct ubi_scan_info *ubi_scan(struct ubi_device *ubi);
|
|
void ubi_scan_destroy_si(struct ubi_scan_info *si);
|
|
|
|
#endif /* !__UBI_SCAN_H__ */
|