[net-next-2.6.git] / include / mtd / mtd-abi.h

/*
 * 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
 *
 */

#ifndef __MTD_ABI_H__
#define __MTD_ABI_H__

#include <linux/types.h>

struct erase_info_user {
	__u32 start;
	__u32 length;
};

struct erase_info_user64 {
	__u64 start;
	__u64 length;
};

struct mtd_oob_buf {
	__u32 start;
	__u32 length;
	unsigned char __user *ptr;
};

struct mtd_oob_buf64 {
	__u64 start;
	__u32 pad;
	__u32 length;
	__u64 usr_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_MLCNANDFLASH	8

#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_POWERUP_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 {
	__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)
	/* The below two fields are obsolete and broken, do not use them
	 * (TODO: remove at some point) */
	__u32 ecctype;
	__u32 eccsize;
};

struct region_info_user {
	__u32 offset;		/* At which this region starts,
					 * from the beginning of the MTD */
	__u32 erasesize;		/* For this region */
	__u32 numblocks;		/* Number of blocks in this region */
	__u32 regionindex;
};

struct otp_info {
	__u32 start;
	__u32 length;
	__u32 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, __kernel_loff_t)
#define MEMSETBADBLOCK		_IOW('M', 12, __kernel_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_user)
#define ECCGETSTATS		_IOR('M', 18, struct mtd_ecc_stats)
#define MTDFILEMODE		_IO('M', 19)
#define MEMERASE64		_IOW('M', 20, struct erase_info_user64)
#define MEMWRITEOOB64		_IOWR('M', 21, struct mtd_oob_buf64)
#define MEMREADOOB64		_IOWR('M', 22, struct mtd_oob_buf64)
#define MEMISLOCKED		_IOR('M', 23, struct erase_info_user)

/*
 * Obsolete legacy interface. Keep it in order not to break userspace
 * interfaces
 */
struct nand_oobinfo {
	__u32 useecc;
	__u32 eccbytes;
	__u32 oobfree[8][2];
	__u32 eccpos[32];
};

struct nand_oobfree {
	__u32 offset;
	__u32 length;
};

#define MTD_MAX_OOBFREE_ENTRIES	8
#define MTD_MAX_ECCPOS_ENTRIES	64
/*
 * OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
 * ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
 * complete set of ECC information. The ioctl truncates the larger internal
 * structure to retain binary compatibility with the static declaration of the
 * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
 * the user struct, not the MAX size of the internal struct nand_ecclayout.
 */
struct nand_ecclayout_user {
	__u32 eccbytes;
	__u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
	__u32 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 {
	__u32 corrected;
	__u32 failed;
	__u32 badblocks;
	__u32 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__ */
Commit	Line	Data
1da177e4	1	/*
a1452a37 DW	2	* Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
	6	* the Free Software Foundation; either version 2 of the License, or
	7	* (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	17	*
1da177e4 LT	18	*/
	19
	20	#ifndef __MTD_ABI_H__
	21	#define __MTD_ABI_H__
	22
ccef7ab5 AB	23	#include <linux/types.h>
ccef7ab5 AB	24
1da177e4	25	struct erase_info_user {
ccef7ab5 AB	26	__u32 start;
ccef7ab5 AB	27	__u32 length;
1da177e4 LT	28	};
1da177e4 LT	29
0dc54e9f KC	30	struct erase_info_user64 {
	31	__u64 start;
	32	__u64 length;
	33	};
	34
1da177e4	35	struct mtd_oob_buf {
ccef7ab5 AB	36	__u32 start;
ccef7ab5 AB	37	__u32 length;
1da177e4 LT	38	unsigned char __user *ptr;
	39	};
	40
aea7cea9 KC	41	struct mtd_oob_buf64 {
	42	__u64 start;
	43	__u32 pad;
	44	__u32 length;
	45	__u64 usr_ptr;
	46	};
	47
1da177e4	48	#define MTD_ABSENT 0
21c8db9e DW	49	#define MTD_RAM 1
21c8db9e DW	50	#define MTD_ROM 2
1da177e4 LT	51	#define MTD_NORFLASH 3
1da177e4 LT	52	#define MTD_NANDFLASH 4
8f15fd55	53	#define MTD_DATAFLASH 6
801c135c	54	#define MTD_UBIVOLUME 7
17a22826	55	#define MTD_MLCNANDFLASH 8
1da177e4	56
8ca9ed5d	57	#define MTD_WRITEABLE 0x400 /* Device is writeable */
5fa43394	58	#define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
92cbfdcc	59	#define MTD_NO_ERASE 0x1000 /* No erase necessary */
e619a75f	60	#define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */
1da177e4 LT	61
	62	// Some common devices / combinations of capabilities
	63	#define MTD_CAP_ROM 0
92cbfdcc	64	#define MTD_CAP_RAM (MTD_WRITEABLE \| MTD_BIT_WRITEABLE \| MTD_NO_ERASE)
5fa43394	65	#define MTD_CAP_NORFLASH (MTD_WRITEABLE \| MTD_BIT_WRITEABLE)
8ca9ed5d	66	#define MTD_CAP_NANDFLASH (MTD_WRITEABLE)
1da177e4	67
1da177e4 LT	68	/* ECC byte placement */
	69	#define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended)
	70	#define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode)
	71	#define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme
	72	#define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read)
90e260c8	73	#define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default
1da177e4	74
31f4233b NP	75	/* OTP mode selection */
	76	#define MTD_OTP_OFF 0
	77	#define MTD_OTP_FACTORY 1
	78	#define MTD_OTP_USER 2
	79
1da177e4	80	struct mtd_info_user {
ccef7ab5 AB	81	__u8 type;
	82	__u32 flags;
	83	__u32 size; // Total size of the MTD
	84	__u32 erasesize;
	85	__u32 writesize;
	86	__u32 oobsize; // Amount of OOB data per block (e.g. 16)
64f60710 AB	87	/* The below two fields are obsolete and broken, do not use them
64f60710 AB	88	* (TODO: remove at some point) */
ccef7ab5 AB	89	__u32 ecctype;
ccef7ab5 AB	90	__u32 eccsize;
1da177e4 LT	91	};
	92
	93	struct region_info_user {
ccef7ab5	94	__u32 offset; /* At which this region starts,
1da177e4	95	* from the beginning of the MTD */
ccef7ab5 AB	96	__u32 erasesize; /* For this region */
	97	__u32 numblocks; /* Number of blocks in this region */
	98	__u32 regionindex;
1da177e4 LT	99	};
1da177e4 LT	100
f77814dd	101	struct otp_info {
ccef7ab5 AB	102	__u32 start;
	103	__u32 length;
	104	__u32 locked;
f77814dd NP	105	};
f77814dd NP	106
5bd34c09 TG	107	#define MEMGETINFO _IOR('M', 1, struct mtd_info_user)
	108	#define MEMERASE _IOW('M', 2, struct erase_info_user)
	109	#define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf)
	110	#define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf)
	111	#define MEMLOCK _IOW('M', 5, struct erase_info_user)
	112	#define MEMUNLOCK _IOW('M', 6, struct erase_info_user)
1da177e4 LT	113	#define MEMGETREGIONCOUNT _IOR('M', 7, int)
	114	#define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
	115	#define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo)
	116	#define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo)
85efde6f AB	117	#define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t)
85efde6f AB	118	#define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t)
31f4233b NP	119	#define OTPSELECT _IOR('M', 13, int)
	120	#define OTPGETREGIONCOUNT _IOW('M', 14, int)
	121	#define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
5bd34c09	122	#define OTPLOCK _IOR('M', 16, struct otp_info)
cc26c3cd	123	#define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout_user)
f1a28c02 TG	124	#define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
f1a28c02 TG	125	#define MTDFILEMODE _IO('M', 19)
0dc54e9f	126	#define MEMERASE64 _IOW('M', 20, struct erase_info_user64)
aea7cea9 KC	127	#define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64)
aea7cea9 KC	128	#define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64)
9938424f	129	#define MEMISLOCKED _IOR('M', 23, struct erase_info_user)
1da177e4	130
5bd34c09 TG	131	/*
	132	* Obsolete legacy interface. Keep it in order not to break userspace
	133	* interfaces
	134	*/
1da177e4	135	struct nand_oobinfo {
ccef7ab5 AB	136	__u32 useecc;
	137	__u32 eccbytes;
	138	__u32 oobfree[8][2];
	139	__u32 eccpos[32];
1da177e4 LT	140	};
1da177e4 LT	141
5bd34c09	142	struct nand_oobfree {
ccef7ab5 AB	143	__u32 offset;
ccef7ab5 AB	144	__u32 length;
5bd34c09 TG	145	};
	146
	147	#define MTD_MAX_OOBFREE_ENTRIES 8
0ceacf36	148	#define MTD_MAX_ECCPOS_ENTRIES 64
5bd34c09	149	/*
0ceacf36 BN	150	* OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
	151	* ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
	152	* complete set of ECC information. The ioctl truncates the larger internal
	153	* structure to retain binary compatibility with the static declaration of the
	154	* ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
	155	* the user struct, not the MAX size of the internal struct nand_ecclayout.
5bd34c09	156	*/
cc26c3cd	157	struct nand_ecclayout_user {
ccef7ab5	158	__u32 eccbytes;
0ceacf36	159	__u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
ccef7ab5	160	__u32 oobavail;
5bd34c09 TG	161	struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
	162	};
	163
f1a28c02	164	/**
ea9b6dcc	165	* struct mtd_ecc_stats - error correction stats
f1a28c02 TG	166	*
	167	* @corrected: number of corrected bits
	168	* @failed: number of uncorrectable errors
	169	* @badblocks: number of bad blocks in this partition
	170	* @bbtblocks: number of blocks reserved for bad block tables
	171	*/
	172	struct mtd_ecc_stats {
ccef7ab5 AB	173	__u32 corrected;
	174	__u32 failed;
	175	__u32 badblocks;
	176	__u32 bbtblocks;
f1a28c02 TG	177	};
	178
	179	/*
	180	* Read/write file modes for access to MTD
	181	*/
	182	enum mtd_file_modes {
	183	MTD_MODE_NORMAL = MTD_OTP_OFF,
	184	MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
	185	MTD_MODE_OTP_USER = MTD_OTP_USER,
	186	MTD_MODE_RAW,
	187	};
	188
1da177e4	189	#endif /* __MTD_ABI_H__ */