[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__

#ifndef __KERNEL__ 
/* Urgh. The whole point of splitting this out into
   separate files was to avoid #ifdef __KERNEL__ */
#define __user
#endif

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_WRITEABLE		0x400	/* Device is writeable */
#define MTD_BIT_WRITEABLE	0x800	/* Single bits can be flipped */
#define MTD_NO_ERASE		0x1000	/* No erase necessary */

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


// Types of automatic ECC/Checksum available
#define MTD_ECC_NONE		0 	// No automatic ECC available
#define MTD_ECC_RS_DiskOnChip	1	// Automatic ECC on DiskOnChip
#define MTD_ECC_SW		2	// SW ECC for Toshiba & Samsung devices

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