[deliverable/linux.git] / include / mtd / mtd-abi.h

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