2005-04-17 05:20:36 +07:00
|
|
|
/*
|
2010-08-09 02:58:20 +07:00
|
|
|
* Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
|
|
|
|
*
|
|
|
|
* 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
*
|
2005-04-17 05:20:36 +07:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __MTD_ABI_H__
|
|
|
|
#define __MTD_ABI_H__
|
|
|
|
|
2009-02-26 06:51:41 +07:00
|
|
|
#include <linux/types.h>
|
|
|
|
|
2005-04-17 05:20:36 +07:00
|
|
|
struct erase_info_user {
|
2009-02-26 06:51:41 +07:00
|
|
|
__u32 start;
|
|
|
|
__u32 length;
|
2005-04-17 05:20:36 +07:00
|
|
|
};
|
|
|
|
|
2009-04-09 12:52:28 +07:00
|
|
|
struct erase_info_user64 {
|
|
|
|
__u64 start;
|
|
|
|
__u64 length;
|
|
|
|
};
|
|
|
|
|
2005-04-17 05:20:36 +07:00
|
|
|
struct mtd_oob_buf {
|
2009-02-26 06:51:41 +07:00
|
|
|
__u32 start;
|
|
|
|
__u32 length;
|
2005-04-17 05:20:36 +07:00
|
|
|
unsigned char __user *ptr;
|
|
|
|
};
|
|
|
|
|
2009-04-09 12:53:49 +07:00
|
|
|
struct mtd_oob_buf64 {
|
|
|
|
__u64 start;
|
|
|
|
__u32 pad;
|
|
|
|
__u32 length;
|
|
|
|
__u64 usr_ptr;
|
|
|
|
};
|
|
|
|
|
2005-04-17 05:20:36 +07:00
|
|
|
#define MTD_ABSENT 0
|
2006-06-15 03:39:48 +07:00
|
|
|
#define MTD_RAM 1
|
|
|
|
#define MTD_ROM 2
|
2005-04-17 05:20:36 +07:00
|
|
|
#define MTD_NORFLASH 3
|
|
|
|
#define MTD_NANDFLASH 4
|
2005-02-09 16:17:45 +07:00
|
|
|
#define MTD_DATAFLASH 6
|
UBI: Unsorted Block Images
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>
2006-06-27 15:22:22 +07:00
|
|
|
#define MTD_UBIVOLUME 7
|
2005-04-17 05:20:36 +07:00
|
|
|
|
2006-05-23 04:17:23 +07:00
|
|
|
#define MTD_WRITEABLE 0x400 /* Device is writeable */
|
2006-05-23 04:18:29 +07:00
|
|
|
#define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
|
2006-05-30 19:25:24 +07:00
|
|
|
#define MTD_NO_ERASE 0x1000 /* No erase necessary */
|
2008-01-31 01:25:49 +07:00
|
|
|
#define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */
|
2005-04-17 05:20:36 +07:00
|
|
|
|
|
|
|
// Some common devices / combinations of capabilities
|
|
|
|
#define MTD_CAP_ROM 0
|
2006-05-30 19:25:24 +07:00
|
|
|
#define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
|
2006-05-23 04:18:29 +07:00
|
|
|
#define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
|
2006-05-23 04:17:23 +07:00
|
|
|
#define MTD_CAP_NANDFLASH (MTD_WRITEABLE)
|
2005-04-17 05:20:36 +07:00
|
|
|
|
|
|
|
/* 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)
|
2005-05-19 23:10:26 +07:00
|
|
|
#define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default
|
2005-04-17 05:20:36 +07:00
|
|
|
|
2005-02-09 00:45:55 +07:00
|
|
|
/* OTP mode selection */
|
|
|
|
#define MTD_OTP_OFF 0
|
|
|
|
#define MTD_OTP_FACTORY 1
|
|
|
|
#define MTD_OTP_USER 2
|
|
|
|
|
2005-04-17 05:20:36 +07:00
|
|
|
struct mtd_info_user {
|
2009-02-26 06:51:41 +07:00
|
|
|
__u8 type;
|
|
|
|
__u32 flags;
|
|
|
|
__u32 size; // Total size of the MTD
|
|
|
|
__u32 erasesize;
|
|
|
|
__u32 writesize;
|
|
|
|
__u32 oobsize; // Amount of OOB data per block (e.g. 16)
|
2007-01-30 15:50:43 +07:00
|
|
|
/* The below two fields are obsolete and broken, do not use them
|
|
|
|
* (TODO: remove at some point) */
|
2009-02-26 06:51:41 +07:00
|
|
|
__u32 ecctype;
|
|
|
|
__u32 eccsize;
|
2005-04-17 05:20:36 +07:00
|
|
|
};
|
|
|
|
|
|
|
|
struct region_info_user {
|
2009-02-26 06:51:41 +07:00
|
|
|
__u32 offset; /* At which this region starts,
|
2005-04-17 05:20:36 +07:00
|
|
|
* from the beginning of the MTD */
|
2009-02-26 06:51:41 +07:00
|
|
|
__u32 erasesize; /* For this region */
|
|
|
|
__u32 numblocks; /* Number of blocks in this region */
|
|
|
|
__u32 regionindex;
|
2005-04-17 05:20:36 +07:00
|
|
|
};
|
|
|
|
|
2005-02-09 00:11:19 +07:00
|
|
|
struct otp_info {
|
2009-02-26 06:51:41 +07:00
|
|
|
__u32 start;
|
|
|
|
__u32 length;
|
|
|
|
__u32 locked;
|
2005-02-09 00:11:19 +07:00
|
|
|
};
|
|
|
|
|
2006-05-28 03:16:10 +07:00
|
|
|
#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)
|
2005-04-17 05:20:36 +07:00
|
|
|
#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)
|
make exported headers use strict posix types
A number of standard posix types are used in exported headers, which
is not allowed if __STRICT_KERNEL_NAMES is defined. In order to
get rid of the non-__STRICT_KERNEL_NAMES part and to make sane headers
the default, we have to change them all to safe types.
There are also still some leftovers in reiserfs_fs.h, elfcore.h
and coda.h, but these files have not compiled in user space for
a long time.
This leaves out the various integer types ({u_,u,}int{8,16,32,64}_t),
which we take care of separately.
Signed-off-by: Arnd Bergmann <arnd@arndb.de>
Acked-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Arnaldo Carvalho de Melo <acme@ghostprotocols.net>
Cc: YOSHIFUJI Hideaki <yoshfuji@linux-ipv6.org>
Cc: netdev@vger.kernel.org
Cc: linux-ppp@vger.kernel.org
Cc: Jaroslav Kysela <perex@perex.cz>
Cc: Takashi Iwai <tiwai@suse.de>
Cc: David Woodhouse <dwmw2@infradead.org>
Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
2009-02-26 06:51:39 +07:00
|
|
|
#define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t)
|
|
|
|
#define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t)
|
2005-02-09 00:45:55 +07:00
|
|
|
#define OTPSELECT _IOR('M', 13, int)
|
|
|
|
#define OTPGETREGIONCOUNT _IOW('M', 14, int)
|
|
|
|
#define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
|
2006-05-28 03:16:10 +07:00
|
|
|
#define OTPLOCK _IOR('M', 16, struct otp_info)
|
|
|
|
#define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout)
|
2006-05-30 05:37:34 +07:00
|
|
|
#define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
|
|
|
|
#define MTDFILEMODE _IO('M', 19)
|
2009-04-09 12:52:28 +07:00
|
|
|
#define MEMERASE64 _IOW('M', 20, struct erase_info_user64)
|
2009-04-09 12:53:49 +07:00
|
|
|
#define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64)
|
|
|
|
#define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64)
|
2010-06-14 23:10:33 +07:00
|
|
|
#define MEMISLOCKED _IOR('M', 23, struct erase_info_user)
|
2005-04-17 05:20:36 +07:00
|
|
|
|
2006-05-28 03:16:10 +07:00
|
|
|
/*
|
|
|
|
* Obsolete legacy interface. Keep it in order not to break userspace
|
|
|
|
* interfaces
|
|
|
|
*/
|
2005-04-17 05:20:36 +07:00
|
|
|
struct nand_oobinfo {
|
2009-02-26 06:51:41 +07:00
|
|
|
__u32 useecc;
|
|
|
|
__u32 eccbytes;
|
|
|
|
__u32 oobfree[8][2];
|
|
|
|
__u32 eccpos[32];
|
2005-04-17 05:20:36 +07:00
|
|
|
};
|
|
|
|
|
2006-05-28 03:16:10 +07:00
|
|
|
struct nand_oobfree {
|
2009-02-26 06:51:41 +07:00
|
|
|
__u32 offset;
|
|
|
|
__u32 length;
|
2006-05-28 03:16:10 +07:00
|
|
|
};
|
|
|
|
|
|
|
|
#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 {
|
2009-02-26 06:51:41 +07:00
|
|
|
__u32 eccbytes;
|
|
|
|
__u32 eccpos[64];
|
|
|
|
__u32 oobavail;
|
2006-05-28 03:16:10 +07:00
|
|
|
struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
|
|
|
|
};
|
|
|
|
|
2006-05-30 05:37:34 +07:00
|
|
|
/**
|
2006-06-29 11:48:38 +07:00
|
|
|
* struct mtd_ecc_stats - error correction stats
|
2006-05-30 05:37:34 +07:00
|
|
|
*
|
|
|
|
* @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 {
|
2009-02-26 06:51:41 +07:00
|
|
|
__u32 corrected;
|
|
|
|
__u32 failed;
|
|
|
|
__u32 badblocks;
|
|
|
|
__u32 bbtblocks;
|
2006-05-30 05:37:34 +07:00
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* 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,
|
|
|
|
};
|
|
|
|
|
2005-04-17 05:20:36 +07:00
|
|
|
#endif /* __MTD_ABI_H__ */
|