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

/*
 * Portions of MTD ABI definition which are shared by kernel and user space
 */

#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_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)
#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)

/*
 * 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
/*
 * ECC layout control structure. Exported to userspace for
 * diagnosis and to allow creation of raw images
 */
struct nand_ecclayout {
	__u32 eccbytes;
	__u32 eccpos[64];
	__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	/*
e4f0648f	2	* Portions of MTD ABI definition which are shared by kernel and user space
1da177e4 LT	3	*/
	4
	5	#ifndef __MTD_ABI_H__
	6	#define __MTD_ABI_H__
	7
ccef7ab5 AB	8	#include <linux/types.h>
ccef7ab5 AB	9
1da177e4	10	struct erase_info_user {
ccef7ab5 AB	11	__u32 start;
ccef7ab5 AB	12	__u32 length;
1da177e4 LT	13	};
1da177e4 LT	14
0dc54e9f KC	15	struct erase_info_user64 {
	16	__u64 start;
	17	__u64 length;
	18	};
	19
1da177e4	20	struct mtd_oob_buf {
ccef7ab5 AB	21	__u32 start;
ccef7ab5 AB	22	__u32 length;
1da177e4 LT	23	unsigned char __user *ptr;
	24	};
	25
aea7cea9 KC	26	struct mtd_oob_buf64 {
	27	__u64 start;
	28	__u32 pad;
	29	__u32 length;
	30	__u64 usr_ptr;
	31	};
	32
1da177e4	33	#define MTD_ABSENT 0
21c8db9e DW	34	#define MTD_RAM 1
21c8db9e DW	35	#define MTD_ROM 2
1da177e4 LT	36	#define MTD_NORFLASH 3
1da177e4 LT	37	#define MTD_NANDFLASH 4
8f15fd55	38	#define MTD_DATAFLASH 6
801c135c	39	#define MTD_UBIVOLUME 7
1da177e4	40
8ca9ed5d	41	#define MTD_WRITEABLE 0x400 /* Device is writeable */
5fa43394	42	#define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
92cbfdcc	43	#define MTD_NO_ERASE 0x1000 /* No erase necessary */
e619a75f	44	#define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */
1da177e4 LT	45
	46	// Some common devices / combinations of capabilities
	47	#define MTD_CAP_ROM 0
92cbfdcc	48	#define MTD_CAP_RAM (MTD_WRITEABLE \| MTD_BIT_WRITEABLE \| MTD_NO_ERASE)
5fa43394	49	#define MTD_CAP_NORFLASH (MTD_WRITEABLE \| MTD_BIT_WRITEABLE)
8ca9ed5d	50	#define MTD_CAP_NANDFLASH (MTD_WRITEABLE)
1da177e4	51
1da177e4 LT	52	/* ECC byte placement */
	53	#define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended)
	54	#define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode)
	55	#define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme
	56	#define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read)
90e260c8	57	#define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default
1da177e4	58
31f4233b NP	59	/* OTP mode selection */
	60	#define MTD_OTP_OFF 0
	61	#define MTD_OTP_FACTORY 1
	62	#define MTD_OTP_USER 2
	63
1da177e4	64	struct mtd_info_user {
ccef7ab5 AB	65	__u8 type;
	66	__u32 flags;
	67	__u32 size; // Total size of the MTD
	68	__u32 erasesize;
	69	__u32 writesize;
	70	__u32 oobsize; // Amount of OOB data per block (e.g. 16)
64f60710 AB	71	/* The below two fields are obsolete and broken, do not use them
64f60710 AB	72	* (TODO: remove at some point) */
ccef7ab5 AB	73	__u32 ecctype;
ccef7ab5 AB	74	__u32 eccsize;
1da177e4 LT	75	};
	76
	77	struct region_info_user {
ccef7ab5	78	__u32 offset; /* At which this region starts,
1da177e4	79	* from the beginning of the MTD */
ccef7ab5 AB	80	__u32 erasesize; /* For this region */
	81	__u32 numblocks; /* Number of blocks in this region */
	82	__u32 regionindex;
1da177e4 LT	83	};
1da177e4 LT	84
f77814dd	85	struct otp_info {
ccef7ab5 AB	86	__u32 start;
	87	__u32 length;
	88	__u32 locked;
f77814dd NP	89	};
f77814dd NP	90
5bd34c09 TG	91	#define MEMGETINFO _IOR('M', 1, struct mtd_info_user)
	92	#define MEMERASE _IOW('M', 2, struct erase_info_user)
	93	#define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf)
	94	#define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf)
	95	#define MEMLOCK _IOW('M', 5, struct erase_info_user)
	96	#define MEMUNLOCK _IOW('M', 6, struct erase_info_user)
1da177e4 LT	97	#define MEMGETREGIONCOUNT _IOR('M', 7, int)
	98	#define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
	99	#define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo)
	100	#define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo)
85efde6f AB	101	#define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t)
85efde6f AB	102	#define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t)
31f4233b NP	103	#define OTPSELECT _IOR('M', 13, int)
	104	#define OTPGETREGIONCOUNT _IOW('M', 14, int)
	105	#define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
5bd34c09 TG	106	#define OTPLOCK _IOR('M', 16, struct otp_info)
5bd34c09 TG	107	#define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout)
f1a28c02 TG	108	#define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
f1a28c02 TG	109	#define MTDFILEMODE _IO('M', 19)
0dc54e9f	110	#define MEMERASE64 _IOW('M', 20, struct erase_info_user64)
aea7cea9 KC	111	#define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64)
aea7cea9 KC	112	#define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64)
1da177e4	113
5bd34c09 TG	114	/*
	115	* Obsolete legacy interface. Keep it in order not to break userspace
	116	* interfaces
	117	*/
1da177e4	118	struct nand_oobinfo {
ccef7ab5 AB	119	__u32 useecc;
	120	__u32 eccbytes;
	121	__u32 oobfree[8][2];
	122	__u32 eccpos[32];
1da177e4 LT	123	};
1da177e4 LT	124
5bd34c09	125	struct nand_oobfree {
ccef7ab5 AB	126	__u32 offset;
ccef7ab5 AB	127	__u32 length;
5bd34c09 TG	128	};
	129
	130	#define MTD_MAX_OOBFREE_ENTRIES 8
	131	/*
	132	* ECC layout control structure. Exported to userspace for
	133	* diagnosis and to allow creation of raw images
	134	*/
	135	struct nand_ecclayout {
ccef7ab5 AB	136	__u32 eccbytes;
	137	__u32 eccpos[64];
	138	__u32 oobavail;
5bd34c09 TG	139	struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
	140	};
	141
f1a28c02	142	/**
ea9b6dcc	143	* struct mtd_ecc_stats - error correction stats
f1a28c02 TG	144	*
	145	* @corrected: number of corrected bits
	146	* @failed: number of uncorrectable errors
	147	* @badblocks: number of bad blocks in this partition
	148	* @bbtblocks: number of blocks reserved for bad block tables
	149	*/
	150	struct mtd_ecc_stats {
ccef7ab5 AB	151	__u32 corrected;
	152	__u32 failed;
	153	__u32 badblocks;
	154	__u32 bbtblocks;
f1a28c02 TG	155	};
	156
	157	/*
	158	* Read/write file modes for access to MTD
	159	*/
	160	enum mtd_file_modes {
	161	MTD_MODE_NORMAL = MTD_OTP_OFF,
	162	MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
	163	MTD_MODE_OTP_USER = MTD_OTP_USER,
	164	MTD_MODE_RAW,
	165	};
	166
1da177e4	167	#endif /* __MTD_ABI_H__ */