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>
152 lines
4.3 KiB
C
152 lines
4.3 KiB
C
/*
|
|
* $Id: mtd-abi.h,v 1.13 2005/11/07 11:14:56 gleixner Exp $
|
|
*
|
|
* Portions of MTD ABI definition which are shared by kernel and user space
|
|
*/
|
|
|
|
#ifndef __MTD_ABI_H__
|
|
#define __MTD_ABI_H__
|
|
|
|
struct erase_info_user {
|
|
uint32_t start;
|
|
uint32_t length;
|
|
};
|
|
|
|
struct mtd_oob_buf {
|
|
uint32_t start;
|
|
uint32_t length;
|
|
unsigned char __user *ptr;
|
|
};
|
|
|
|
#define MTD_ABSENT 0
|
|
#define MTD_RAM 1
|
|
#define MTD_ROM 2
|
|
#define MTD_NORFLASH 3
|
|
#define MTD_NANDFLASH 4
|
|
#define MTD_DATAFLASH 6
|
|
#define MTD_UBIVOLUME 7
|
|
|
|
#define MTD_WRITEABLE 0x400 /* Device is writeable */
|
|
#define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
|
|
#define MTD_NO_ERASE 0x1000 /* No erase necessary */
|
|
#define MTD_STUPID_LOCK 0x2000 /* Always locked after reset */
|
|
|
|
// Some common devices / combinations of capabilities
|
|
#define MTD_CAP_ROM 0
|
|
#define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
|
|
#define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
|
|
#define MTD_CAP_NANDFLASH (MTD_WRITEABLE)
|
|
|
|
/* ECC byte placement */
|
|
#define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended)
|
|
#define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode)
|
|
#define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme
|
|
#define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read)
|
|
#define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default
|
|
|
|
/* OTP mode selection */
|
|
#define MTD_OTP_OFF 0
|
|
#define MTD_OTP_FACTORY 1
|
|
#define MTD_OTP_USER 2
|
|
|
|
struct mtd_info_user {
|
|
uint8_t type;
|
|
uint32_t flags;
|
|
uint32_t size; // Total size of the MTD
|
|
uint32_t erasesize;
|
|
uint32_t writesize;
|
|
uint32_t oobsize; // Amount of OOB data per block (e.g. 16)
|
|
/* The below two fields are obsolete and broken, do not use them
|
|
* (TODO: remove at some point) */
|
|
uint32_t ecctype;
|
|
uint32_t eccsize;
|
|
};
|
|
|
|
struct region_info_user {
|
|
uint32_t offset; /* At which this region starts,
|
|
* from the beginning of the MTD */
|
|
uint32_t erasesize; /* For this region */
|
|
uint32_t numblocks; /* Number of blocks in this region */
|
|
uint32_t regionindex;
|
|
};
|
|
|
|
struct otp_info {
|
|
uint32_t start;
|
|
uint32_t length;
|
|
uint32_t locked;
|
|
};
|
|
|
|
#define MEMGETINFO _IOR('M', 1, struct mtd_info_user)
|
|
#define MEMERASE _IOW('M', 2, struct erase_info_user)
|
|
#define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf)
|
|
#define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf)
|
|
#define MEMLOCK _IOW('M', 5, struct erase_info_user)
|
|
#define MEMUNLOCK _IOW('M', 6, struct erase_info_user)
|
|
#define MEMGETREGIONCOUNT _IOR('M', 7, int)
|
|
#define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
|
|
#define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo)
|
|
#define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo)
|
|
#define MEMGETBADBLOCK _IOW('M', 11, loff_t)
|
|
#define MEMSETBADBLOCK _IOW('M', 12, loff_t)
|
|
#define OTPSELECT _IOR('M', 13, int)
|
|
#define OTPGETREGIONCOUNT _IOW('M', 14, int)
|
|
#define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
|
|
#define OTPLOCK _IOR('M', 16, struct otp_info)
|
|
#define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout)
|
|
#define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
|
|
#define MTDFILEMODE _IO('M', 19)
|
|
|
|
/*
|
|
* Obsolete legacy interface. Keep it in order not to break userspace
|
|
* interfaces
|
|
*/
|
|
struct nand_oobinfo {
|
|
uint32_t useecc;
|
|
uint32_t eccbytes;
|
|
uint32_t oobfree[8][2];
|
|
uint32_t eccpos[32];
|
|
};
|
|
|
|
struct nand_oobfree {
|
|
uint32_t offset;
|
|
uint32_t length;
|
|
};
|
|
|
|
#define MTD_MAX_OOBFREE_ENTRIES 8
|
|
/*
|
|
* ECC layout control structure. Exported to userspace for
|
|
* diagnosis and to allow creation of raw images
|
|
*/
|
|
struct nand_ecclayout {
|
|
uint32_t eccbytes;
|
|
uint32_t eccpos[64];
|
|
uint32_t oobavail;
|
|
struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
|
|
};
|
|
|
|
/**
|
|
* struct mtd_ecc_stats - error correction stats
|
|
*
|
|
* @corrected: number of corrected bits
|
|
* @failed: number of uncorrectable errors
|
|
* @badblocks: number of bad blocks in this partition
|
|
* @bbtblocks: number of blocks reserved for bad block tables
|
|
*/
|
|
struct mtd_ecc_stats {
|
|
uint32_t corrected;
|
|
uint32_t failed;
|
|
uint32_t badblocks;
|
|
uint32_t bbtblocks;
|
|
};
|
|
|
|
/*
|
|
* Read/write file modes for access to MTD
|
|
*/
|
|
enum mtd_file_modes {
|
|
MTD_MODE_NORMAL = MTD_OTP_OFF,
|
|
MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
|
|
MTD_MODE_OTP_USER = MTD_OTP_USER,
|
|
MTD_MODE_RAW,
|
|
};
|
|
|
|
#endif /* __MTD_ABI_H__ */
|